cdefs.h@ 48418

Last change on this file since 48418 was 47435, checked in by vboxsync, 11 years ago
iprt/cdefs.h: RT_INLINE_ASM_USES_INTRIN = major MSC version number so we can select bits which are available and which are not more easily.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 91.2 KB

Line
1	/** @file
2	* IPRT - Common C and C++ definitions.
3	*/
4
5	/*
6	* Copyright (C) 2006-2012 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 IN_RING0
62	# define IN_RING3
63	# define IN_RC
64	# define IN_RC
65	# define IN_RT_RC
66	# define IN_RT_R0
67	# define IN_RT_R3
68	# define IN_RT_STATIC
69	# define RT_STRICT
70	# define RT_NO_STRICT
71	# define RT_LOCK_STRICT
72	# define RT_LOCK_NO_STRICT
73	# define RT_LOCK_STRICT_ORDER
74	# define RT_LOCK_NO_STRICT_ORDER
75	# define Breakpoint
76	# define RT_NO_DEPRECATED_MACROS
77	# define RT_EXCEPTIONS_ENABLED
78	# define RT_BIG_ENDIAN
79	# define RT_LITTLE_ENDIAN
80	# define RT_COMPILER_GROKS_64BIT_BITFIELDS
81	# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
82	# define RT_NO_VISIBILITY_HIDDEN
83	#endif /* DOXYGEN_RUNNING */
84
85	/** @def RT_ARCH_X86
86	* Indicates that we're compiling for the X86 architecture.
87	*/
88
89	/** @def RT_ARCH_AMD64
90	* Indicates that we're compiling for the AMD64 architecture.
91	*/
92
93	/** @def RT_ARCH_SPARC
94	* Indicates that we're compiling for the SPARC V8 architecture (32-bit).
95	*/
96
97	/** @def RT_ARCH_SPARC64
98	* Indicates that we're compiling for the SPARC V9 architecture (64-bit).
99	*/
100	#if !defined(RT_ARCH_X86) \
101	&& !defined(RT_ARCH_AMD64) \
102	&& !defined(RT_ARCH_SPARC) \
103	&& !defined(RT_ARCH_SPARC64) \
104	&& !defined(RT_ARCH_ARM)
105	# if defined(__amd64__) \|\| defined(__x86_64__) \|\| defined(_M_X64) \|\| defined(__AMD64__)
106	# define RT_ARCH_AMD64
107	# elif defined(__i386__) \|\| defined(_M_IX86) \|\| defined(__X86__)
108	# define RT_ARCH_X86
109	# elif defined(__sparcv9)
110	# define RT_ARCH_SPARC64
111	# elif defined(__sparc__)
112	# define RT_ARCH_SPARC
113	# elif defined(__arm__) \|\| defined(__arm32__)
114	# define RT_ARCH_ARM
115	# else /* PORTME: append test for new archs. */
116	# error "Check what predefined macros your compiler uses to indicate architecture."
117	# endif
118	/* PORTME: append new archs checks. */
119	#elif defined(RT_ARCH_X86) && defined(RT_ARCH_AMD64)
120	# error "Both RT_ARCH_X86 and RT_ARCH_AMD64 cannot be defined at the same time!"
121	#elif defined(RT_ARCH_X86) && defined(RT_ARCH_SPARC)
122	# error "Both RT_ARCH_X86 and RT_ARCH_SPARC cannot be defined at the same time!"
123	#elif defined(RT_ARCH_X86) && defined(RT_ARCH_SPARC64)
124	# error "Both RT_ARCH_X86 and RT_ARCH_SPARC64 cannot be defined at the same time!"
125	#elif defined(RT_ARCH_AMD64) && defined(RT_ARCH_SPARC)
126	# error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC cannot be defined at the same time!"
127	#elif defined(RT_ARCH_AMD64) && defined(RT_ARCH_SPARC64)
128	# error "Both RT_ARCH_AMD64 and RT_ARCH_SPARC64 cannot be defined at the same time!"
129	#elif defined(RT_ARCH_SPARC) && defined(RT_ARCH_SPARC64)
130	# error "Both RT_ARCH_SPARC and RT_ARCH_SPARC64 cannot be defined at the same time!"
131	#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_AMD64)
132	# error "Both RT_ARCH_ARM and RT_ARCH_AMD64 cannot be defined at the same time!"
133	#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_X86)
134	# error "Both RT_ARCH_ARM and RT_ARCH_X86 cannot be defined at the same time!"
135	#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_SPARC64)
136	# error "Both RT_ARCH_ARM and RT_ARCH_SPARC64 cannot be defined at the same time!"
137	#elif defined(RT_ARCH_ARM) && defined(RT_ARCH_SPARC)
138	# error "Both RT_ARCH_ARM and RT_ARCH_SPARC cannot be defined at the same time!"
139	#endif
140
141
142	/** @def __X86__
143	* Indicates that we're compiling for the X86 architecture.
144	* @deprecated
145	*/
146
147	/** @def __AMD64__
148	* Indicates that we're compiling for the AMD64 architecture.
149	* @deprecated
150	*/
151	#if !defined(__X86__) && !defined(__AMD64__) && (defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86))
152	# if defined(RT_ARCH_AMD64)
153	# define __AMD64__
154	# elif defined(RT_ARCH_X86)
155	# define __X86__
156	# else
157	# error "Check what predefined macros your compiler uses to indicate architecture."
158	# endif
159	#elif defined(__X86__) && defined(__AMD64__)
160	# error "Both __X86__ and __AMD64__ cannot be defined at the same time!"
161	#elif defined(__X86__) && !defined(RT_ARCH_X86)
162	# error "__X86__ without RT_ARCH_X86!"
163	#elif defined(__AMD64__) && !defined(RT_ARCH_AMD64)
164	# error "__AMD64__ without RT_ARCH_AMD64!"
165	#endif
166
167	/** @def RT_BIG_ENDIAN
168	* Defined if the architecture is big endian. */
169	/** @def RT_LITTLE_ENDIAN
170	* Defined if the architecture is little endian. */
171	#if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86) \|\| defined(RT_ARCH_ARM)
172	# define RT_LITTLE_ENDIAN
173	#elif defined(RT_ARCH_SPARC) \|\| defined(RT_ARCH_SPARC64)
174	# define RT_BIG_ENDIAN
175	#else
176	# error "PORTME: architecture endianess"
177	#endif
178	#if defined(RT_BIG_ENDIAN) && defined(RT_LITTLE_ENDIAN)
179	# error "Both RT_BIG_ENDIAN and RT_LITTLE_ENDIAN are defined"
180	#endif
181
182
183	/** @def IN_RING0
184	* Used to indicate that we're compiling code which is running
185	* in Ring-0 Host Context.
186	*/
187
188	/** @def IN_RING3
189	* Used to indicate that we're compiling code which is running
190	* in Ring-3 Host Context.
191	*/
192
193	/** @def IN_RC
194	* Used to indicate that we're compiling code which is running
195	* in the Raw-mode Context (implies R0).
196	*/
197	#if !defined(IN_RING3) && !defined(IN_RING0) && !defined(IN_RC) && !defined(IN_RC)
198	# error "You must define which context the compiled code should run in; IN_RING3, IN_RING0 or IN_RC"
199	#endif
200	#if (defined(IN_RING3) && (defined(IN_RING0) \|\| defined(IN_RC)) ) \
201	\|\| (defined(IN_RING0) && (defined(IN_RING3) \|\| defined(IN_RC)) ) \
202	\|\| (defined(IN_RC) && (defined(IN_RING3) \|\| defined(IN_RING0)) )
203	# error "Only one of the IN_RING3, IN_RING0, IN_RC defines should be defined."
204	#endif
205
206
207	/** @def ARCH_BITS
208	* Defines the bit count of the current context.
209	*/
210	#if !defined(ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
211	# if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_SPARC64)
212	# define ARCH_BITS 64
213	# else
214	# define ARCH_BITS 32
215	# endif
216	#endif
217
218	/** @def HC_ARCH_BITS
219	* Defines the host architecture bit count.
220	*/
221	#if !defined(HC_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
222	# ifndef IN_RC
223	# define HC_ARCH_BITS ARCH_BITS
224	# else
225	# define HC_ARCH_BITS 32
226	# endif
227	#endif
228
229	/** @def GC_ARCH_BITS
230	* Defines the guest architecture bit count.
231	*/
232	#if !defined(GC_ARCH_BITS) && !defined(DOXYGEN_RUNNING)
233	# ifdef VBOX_WITH_64_BITS_GUESTS
234	# define GC_ARCH_BITS 64
235	# else
236	# define GC_ARCH_BITS 32
237	# endif
238	#endif
239
240	/** @def R3_ARCH_BITS
241	* Defines the host ring-3 architecture bit count.
242	*/
243	#if !defined(R3_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
244	# ifdef IN_RING3
245	# define R3_ARCH_BITS ARCH_BITS
246	# else
247	# define R3_ARCH_BITS HC_ARCH_BITS
248	# endif
249	#endif
250
251	/** @def R0_ARCH_BITS
252	* Defines the host ring-0 architecture bit count.
253	*/
254	#if !defined(R0_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
255	# ifdef IN_RING0
256	# define R0_ARCH_BITS ARCH_BITS
257	# else
258	# define R0_ARCH_BITS HC_ARCH_BITS
259	# endif
260	#endif
261
262	/** @def GC_ARCH_BITS
263	* Defines the guest architecture bit count.
264	*/
265	#if !defined(GC_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
266	# ifdef IN_RC
267	# define GC_ARCH_BITS ARCH_BITS
268	# else
269	# define GC_ARCH_BITS 32
270	# endif
271	#endif
272
273
274
275	/** @name RT_OPSYS_XXX - Operative System Identifiers.
276	* These are the value that the RT_OPSYS \#define can take. @{
277	*/
278	/** Unknown OS. */
279	#define RT_OPSYS_UNKNOWN 0
280	/** OS Agnostic. */
281	#define RT_OPSYS_AGNOSTIC 1
282	/** Darwin - aka Mac OS X. */
283	#define RT_OPSYS_DARWIN 2
284	/** DragonFly BSD. */
285	#define RT_OPSYS_DRAGONFLY 3
286	/** DOS. */
287	#define RT_OPSYS_DOS 4
288	/** FreeBSD. */
289	#define RT_OPSYS_FREEBSD 5
290	/** Haiku. */
291	#define RT_OPSYS_HAIKU 6
292	/** Linux. */
293	#define RT_OPSYS_LINUX 7
294	/** L4. */
295	#define RT_OPSYS_L4 8
296	/** Minix. */
297	#define RT_OPSYS_MINIX 9
298	/** NetBSD. */
299	#define RT_OPSYS_NETBSD 11
300	/** Netware. */
301	#define RT_OPSYS_NETWARE 12
302	/** NT (native). */
303	#define RT_OPSYS_NT 13
304	/** OpenBSD. */
305	#define RT_OPSYS_OPENBSD 14
306	/** OS/2. */
307	#define RT_OPSYS_OS2 15
308	/** Plan 9. */
309	#define RT_OPSYS_PLAN9 16
310	/** QNX. */
311	#define RT_OPSYS_QNX 17
312	/** Solaris. */
313	#define RT_OPSYS_SOLARIS 18
314	/** UEFI. */
315	#define RT_OPSYS_UEFI 19
316	/** Windows. */
317	#define RT_OPSYS_WINDOWS 20
318	/** The max RT_OPSYS_XXX value (exclusive). */
319	#define RT_OPSYS_MAX 21
320	/** @} */
321
322	/** @def RT_OPSYS
323	* Indicates which OS we're targetting. It's a \#define with is
324	* assigned one of the RT_OPSYS_XXX defines above.
325	*
326	* So to test if we're on FreeBSD do the following:
327	* @code
328	* #if RT_OPSYS == RT_OPSYS_FREEBSD
329	* some_funky_freebsd_specific_stuff();
330	* #endif
331	* @endcode
332	*/
333
334	/*
335	* Set RT_OPSYS_XXX according to RT_OS_XXX.
336	*
337	* Search: #define RT_OPSYS_([A-Z0-9]+) .*
338	* Replace: # elif defined(RT_OS_\1)\n# define RT_OPSYS RT_OPSYS_\1
339	*/
340	#ifndef RT_OPSYS
341	# if defined(RT_OS_UNKNOWN)
342	# define RT_OPSYS RT_OPSYS_UNKNOWN
343	# elif defined(RT_OS_AGNOSTIC)
344	# define RT_OPSYS RT_OPSYS_AGNOSTIC
345	# elif defined(RT_OS_DARWIN)
346	# define RT_OPSYS RT_OPSYS_DARWIN
347	# elif defined(RT_OS_DRAGONFLY)
348	# define RT_OPSYS RT_OPSYS_DRAGONFLY
349	# elif defined(RT_OS_DOS)
350	# define RT_OPSYS RT_OPSYS_DOS
351	# elif defined(RT_OS_FREEBSD)
352	# define RT_OPSYS RT_OPSYS_FREEBSD
353	# elif defined(RT_OS_HAIKU)
354	# define RT_OPSYS RT_OPSYS_HAIKU
355	# elif defined(RT_OS_LINUX)
356	# define RT_OPSYS RT_OPSYS_LINUX
357	# elif defined(RT_OS_L4)
358	# define RT_OPSYS RT_OPSYS_L4
359	# elif defined(RT_OS_MINIX)
360	# define RT_OPSYS RT_OPSYS_MINIX
361	# elif defined(RT_OS_NETBSD)
362	# define RT_OPSYS RT_OPSYS_NETBSD
363	# elif defined(RT_OS_NETWARE)
364	# define RT_OPSYS RT_OPSYS_NETWARE
365	# elif defined(RT_OS_NT)
366	# define RT_OPSYS RT_OPSYS_NT
367	# elif defined(RT_OS_OPENBSD)
368	# define RT_OPSYS RT_OPSYS_OPENBSD
369	# elif defined(RT_OS_OS2)
370	# define RT_OPSYS RT_OPSYS_OS2
371	# elif defined(RT_OS_PLAN9)
372	# define RT_OPSYS RT_OPSYS_PLAN9
373	# elif defined(RT_OS_QNX)
374	# define RT_OPSYS RT_OPSYS_QNX
375	# elif defined(RT_OS_SOLARIS)
376	# define RT_OPSYS RT_OPSYS_SOLARIS
377	# elif defined(RT_OS_UEFI)
378	# define RT_OPSYS RT_OPSYS_UEFI
379	# elif defined(RT_OS_WINDOWS)
380	# define RT_OPSYS RT_OPSYS_WINDOWS
381	# endif
382	#endif
383
384	/*
385	* Guess RT_OPSYS based on compiler predefined macros.
386	*/
387	#ifndef RT_OPSYS
388	# if defined(__APPLE__)
389	# define RT_OPSYS RT_OPSYS_DARWIN
390	# elif defined(__DragonFly__)
391	# define RT_OPSYS RT_OPSYS_DRAGONFLY
392	# elif defined(__FreeBSD__) /??/
393	# define RT_OPSYS RT_OPSYS_FREEBSD
394	# elif defined(__gnu_linux__)
395	# define RT_OPSYS RT_OPSYS_LINUX
396	# elif defined(__NetBSD__) /??/
397	# define RT_OPSYS RT_OPSYS_NETBSD
398	# elif defined(__OpenBSD__) /??/
399	# define RT_OPSYS RT_OPSYS_OPENBSD
400	# elif defined(__OS2__)
401	# define RT_OPSYS RT_OPSYS_OS2
402	# elif defined(__sun__) \|\| defined(__SunOS__) \|\| defined(__sun) \|\| defined(__SunOS)
403	# define RT_OPSYS RT_OPSYS_SOLARIS
404	# elif defined(_WIN32) \|\| defined(_WIN64)
405	# define RT_OPSYS RT_OPSYS_WINDOWS
406	# else
407	# error "Port Me"
408	# endif
409	#endif
410
411	#if RT_OPSYS < RT_OPSYS_UNKNOWN \|\| RT_OPSYS >= RT_OPSYS_MAX
412	# error "Invalid RT_OPSYS value."
413	#endif
414
415	/*
416	* Do some consistency checks.
417	*
418	* Search: #define RT_OPSYS_([A-Z0-9]+) .*
419	* Replace: #if defined(RT_OS_\1) && RT_OPSYS != RT_OPSYS_\1\n# error RT_OPSYS vs RT_OS_\1\n#endif
420	*/
421	#if defined(RT_OS_UNKNOWN) && RT_OPSYS != RT_OPSYS_UNKNOWN
422	# error RT_OPSYS vs RT_OS_UNKNOWN
423	#endif
424	#if defined(RT_OS_AGNOSTIC) && RT_OPSYS != RT_OPSYS_AGNOSTIC
425	# error RT_OPSYS vs RT_OS_AGNOSTIC
426	#endif
427	#if defined(RT_OS_DARWIN) && RT_OPSYS != RT_OPSYS_DARWIN
428	# error RT_OPSYS vs RT_OS_DARWIN
429	#endif
430	#if defined(RT_OS_DRAGONFLY) && RT_OPSYS != RT_OPSYS_DRAGONFLY
431	# error RT_OPSYS vs RT_OS_DRAGONFLY
432	#endif
433	#if defined(RT_OS_DOS) && RT_OPSYS != RT_OPSYS_DOS
434	# error RT_OPSYS vs RT_OS_DOS
435	#endif
436	#if defined(RT_OS_FREEBSD) && RT_OPSYS != RT_OPSYS_FREEBSD
437	# error RT_OPSYS vs RT_OS_FREEBSD
438	#endif
439	#if defined(RT_OS_HAIKU) && RT_OPSYS != RT_OPSYS_HAIKU
440	# error RT_OPSYS vs RT_OS_HAIKU
441	#endif
442	#if defined(RT_OS_LINUX) && RT_OPSYS != RT_OPSYS_LINUX
443	# error RT_OPSYS vs RT_OS_LINUX
444	#endif
445	#if defined(RT_OS_L4) && RT_OPSYS != RT_OPSYS_L4
446	# error RT_OPSYS vs RT_OS_L4
447	#endif
448	#if defined(RT_OS_MINIX) && RT_OPSYS != RT_OPSYS_MINIX
449	# error RT_OPSYS vs RT_OS_MINIX
450	#endif
451	#if defined(RT_OS_NETBSD) && RT_OPSYS != RT_OPSYS_NETBSD
452	# error RT_OPSYS vs RT_OS_NETBSD
453	#endif
454	#if defined(RT_OS_NETWARE) && RT_OPSYS != RT_OPSYS_NETWARE
455	# error RT_OPSYS vs RT_OS_NETWARE
456	#endif
457	#if defined(RT_OS_NT) && RT_OPSYS != RT_OPSYS_NT
458	# error RT_OPSYS vs RT_OS_NT
459	#endif
460	#if defined(RT_OS_OPENBSD) && RT_OPSYS != RT_OPSYS_OPENBSD
461	# error RT_OPSYS vs RT_OS_OPENBSD
462	#endif
463	#if defined(RT_OS_OS2) && RT_OPSYS != RT_OPSYS_OS2
464	# error RT_OPSYS vs RT_OS_OS2
465	#endif
466	#if defined(RT_OS_PLAN9) && RT_OPSYS != RT_OPSYS_PLAN9
467	# error RT_OPSYS vs RT_OS_PLAN9
468	#endif
469	#if defined(RT_OS_QNX) && RT_OPSYS != RT_OPSYS_QNX
470	# error RT_OPSYS vs RT_OS_QNX
471	#endif
472	#if defined(RT_OS_SOLARIS) && RT_OPSYS != RT_OPSYS_SOLARIS
473	# error RT_OPSYS vs RT_OS_SOLARIS
474	#endif
475	#if defined(RT_OS_UEFI) && RT_OPSYS != RT_OPSYS_UEFI
476	# error RT_OPSYS vs RT_OS_UEFI
477	#endif
478	#if defined(RT_OS_WINDOWS) && RT_OPSYS != RT_OPSYS_WINDOWS
479	# error RT_OPSYS vs RT_OS_WINDOWS
480	#endif
481
482	/*
483	* Make sure the RT_OS_XXX macro is defined.
484	*
485	* Search: #define RT_OPSYS_([A-Z0-9]+) .*
486	* Replace: #elif RT_OPSYS == RT_OPSYS_\1\n# ifndef RT_OS_\1\n# define RT_OS_\1\n# endif
487	*/
488	#if RT_OPSYS == RT_OPSYS_UNKNOWN
489	# ifndef RT_OS_UNKNOWN
490	# define RT_OS_UNKNOWN
491	# endif
492	#elif RT_OPSYS == RT_OPSYS_AGNOSTIC
493	# ifndef RT_OS_AGNOSTIC
494	# define RT_OS_AGNOSTIC
495	# endif
496	#elif RT_OPSYS == RT_OPSYS_DARWIN
497	# ifndef RT_OS_DARWIN
498	# define RT_OS_DARWIN
499	# endif
500	#elif RT_OPSYS == RT_OPSYS_DRAGONFLY
501	# ifndef RT_OS_DRAGONFLY
502	# define RT_OS_DRAGONFLY
503	# endif
504	#elif RT_OPSYS == RT_OPSYS_DOS
505	# ifndef RT_OS_DOS
506	# define RT_OS_DOS
507	# endif
508	#elif RT_OPSYS == RT_OPSYS_FREEBSD
509	# ifndef RT_OS_FREEBSD
510	# define RT_OS_FREEBSD
511	# endif
512	#elif RT_OPSYS == RT_OPSYS_HAIKU
513	# ifndef RT_OS_HAIKU
514	# define RT_OS_HAIKU
515	# endif
516	#elif RT_OPSYS == RT_OPSYS_LINUX
517	# ifndef RT_OS_LINUX
518	# define RT_OS_LINUX
519	# endif
520	#elif RT_OPSYS == RT_OPSYS_L4
521	# ifndef RT_OS_L4
522	# define RT_OS_L4
523	# endif
524	#elif RT_OPSYS == RT_OPSYS_MINIX
525	# ifndef RT_OS_MINIX
526	# define RT_OS_MINIX
527	# endif
528	#elif RT_OPSYS == RT_OPSYS_NETBSD
529	# ifndef RT_OS_NETBSD
530	# define RT_OS_NETBSD
531	# endif
532	#elif RT_OPSYS == RT_OPSYS_NETWARE
533	# ifndef RT_OS_NETWARE
534	# define RT_OS_NETWARE
535	# endif
536	#elif RT_OPSYS == RT_OPSYS_NT
537	# ifndef RT_OS_NT
538	# define RT_OS_NT
539	# endif
540	#elif RT_OPSYS == RT_OPSYS_OPENBSD
541	# ifndef RT_OS_OPENBSD
542	# define RT_OS_OPENBSD
543	# endif
544	#elif RT_OPSYS == RT_OPSYS_OS2
545	# ifndef RT_OS_OS2
546	# define RT_OS_OS2
547	# endif
548	#elif RT_OPSYS == RT_OPSYS_PLAN9
549	# ifndef RT_OS_PLAN9
550	# define RT_OS_PLAN9
551	# endif
552	#elif RT_OPSYS == RT_OPSYS_QNX
553	# ifndef RT_OS_QNX
554	# define RT_OS_QNX
555	# endif
556	#elif RT_OPSYS == RT_OPSYS_SOLARIS
557	# ifndef RT_OS_SOLARIS
558	# define RT_OS_SOLARIS
559	# endif
560	#elif RT_OPSYS == RT_OPSYS_UEFI
561	# ifndef RT_OS_UEFI
562	# define RT_OS_UEFI
563	# endif
564	#elif RT_OPSYS == RT_OPSYS_WINDOWS
565	# ifndef RT_OS_WINDOWS
566	# define RT_OS_WINDOWS
567	# endif
568	#else
569	# error "Bad RT_OPSYS value."
570	#endif
571
572
573	/**
574	* Checks whether the given OpSys uses DOS-style paths or not.
575	*
576	* By DOS-style paths we include drive lettering and UNC paths.
577	*
578	* @returns true / false
579	* @param a_OpSys The RT_OPSYS_XXX value to check, will be reference
580	* multiple times.
581	*/
582	#define RT_OPSYS_USES_DOS_PATHS(a_OpSys) \
583	( (a_OpSys) == RT_OPSYS_WINDOWS \
584	\|\| (a_OpSys) == RT_OPSYS_OS2 \
585	\|\| (a_OpSys) == RT_OPSYS_DOS )
586
587
588
589	/** @def CTXTYPE
590	* Declare a type differently in GC, R3 and R0.
591	*
592	* @param GCType The GC type.
593	* @param R3Type The R3 type.
594	* @param R0Type The R0 type.
595	* @remark For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
596	*/
597	#ifdef IN_RC
598	# define CTXTYPE(GCType, R3Type, R0Type) GCType
599	#elif defined(IN_RING3)
600	# define CTXTYPE(GCType, R3Type, R0Type) R3Type
601	#else
602	# define CTXTYPE(GCType, R3Type, R0Type) R0Type
603	#endif
604
605	/** @def RCPTRTYPE
606	* Declare a pointer which is used in the raw mode context but appears in structure(s) used by
607	* both HC and RC. The main purpose is to make sure structures have the same
608	* size when built for different architectures.
609	*
610	* @param RCType The RC type.
611	*/
612	#define RCPTRTYPE(RCType) CTXTYPE(RCType, RTRCPTR, RTRCPTR)
613
614	/** @def R3R0PTRTYPE
615	* Declare a pointer which is used in HC, is explicitly valid in ring 3 and 0,
616	* but appears in structure(s) used by both HC and GC. The main purpose is to
617	* make sure structures have the same size when built for different architectures.
618	*
619	* @param R3R0Type The R3R0 type.
620	* @remarks This used to be called HCPTRTYPE.
621	*/
622	#define R3R0PTRTYPE(R3R0Type) CTXTYPE(RTHCPTR, R3R0Type, R3R0Type)
623
624	/** @def R3PTRTYPE
625	* Declare a pointer which is used in R3 but appears in structure(s) used by
626	* both HC and GC. The main purpose is to make sure structures have the same
627	* size when built for different architectures.
628	*
629	* @param R3Type The R3 type.
630	*/
631	#define R3PTRTYPE(R3Type) CTXTYPE(RTHCUINTPTR, R3Type, RTHCUINTPTR)
632
633	/** @def R0PTRTYPE
634	* Declare a pointer which is used in R0 but appears in structure(s) used by
635	* both HC and GC. The main purpose is to make sure structures have the same
636	* size when built for different architectures.
637	*
638	* @param R0Type The R0 type.
639	*/
640	#define R0PTRTYPE(R0Type) CTXTYPE(RTHCUINTPTR, RTHCUINTPTR, R0Type)
641
642	/** @def CTXSUFF
643	* Adds the suffix of the current context to the passed in
644	* identifier name. The suffix is HC or GC.
645	*
646	* This is macro should only be used in shared code to avoid a forest of ifdefs.
647	* @param var Identifier name.
648	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
649	*/
650	/** @def OTHERCTXSUFF
651	* Adds the suffix of the other context to the passed in
652	* identifier name. The suffix is HC or GC.
653	*
654	* This is macro should only be used in shared code to avoid a forest of ifdefs.
655	* @param var Identifier name.
656	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
657	*/
658	#ifdef IN_RC
659	# define CTXSUFF(var) var##GC
660	# define OTHERCTXSUFF(var) var##HC
661	#else
662	# define CTXSUFF(var) var##HC
663	# define OTHERCTXSUFF(var) var##GC
664	#endif
665
666	/** @def CTXALLSUFF
667	* Adds the suffix of the current context to the passed in
668	* identifier name. The suffix is R3, R0 or GC.
669	*
670	* This is macro should only be used in shared code to avoid a forest of ifdefs.
671	* @param var Identifier name.
672	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
673	*/
674	#ifdef IN_RC
675	# define CTXALLSUFF(var) var##GC
676	#elif defined(IN_RING0)
677	# define CTXALLSUFF(var) var##R0
678	#else
679	# define CTXALLSUFF(var) var##R3
680	#endif
681
682	/** @def CTX_SUFF
683	* Adds the suffix of the current context to the passed in
684	* identifier name. The suffix is R3, R0 or RC.
685	*
686	* This is macro should only be used in shared code to avoid a forest of ifdefs.
687	* @param var Identifier name.
688	*
689	* @remark This will replace CTXALLSUFF and CTXSUFF before long.
690	*/
691	#ifdef IN_RC
692	# define CTX_SUFF(var) var##RC
693	#elif defined(IN_RING0)
694	# define CTX_SUFF(var) var##R0
695	#else
696	# define CTX_SUFF(var) var##R3
697	#endif
698
699	/** @def CTX_SUFF_Z
700	* Adds the suffix of the current context to the passed in
701	* identifier name, combining RC and R0 into RZ.
702	* The suffix thus is R3 or RZ.
703	*
704	* This is macro should only be used in shared code to avoid a forest of ifdefs.
705	* @param var Identifier name.
706	*
707	* @remark This will replace CTXALLSUFF and CTXSUFF before long.
708	*/
709	#ifdef IN_RING3
710	# define CTX_SUFF_Z(var) var##R3
711	#else
712	# define CTX_SUFF_Z(var) var##RZ
713	#endif
714
715
716	/** @def CTXMID
717	* Adds the current context as a middle name of an identifier name
718	* The middle name is HC or GC.
719	*
720	* This is macro should only be used in shared code to avoid a forest of ifdefs.
721	* @param first First name.
722	* @param last Surname.
723	*/
724	/** @def OTHERCTXMID
725	* Adds the other context as a middle name of an identifier name
726	* The middle name is HC or GC.
727	*
728	* This is macro should only be used in shared code to avoid a forest of ifdefs.
729	* @param first First name.
730	* @param last Surname.
731	* @deprecated use CTX_MID or CTX_MID_Z
732	*/
733	#ifdef IN_RC
734	# define CTXMID(first, last) first##GC##last
735	# define OTHERCTXMID(first, last) first##HC##last
736	#else
737	# define CTXMID(first, last) first##HC##last
738	# define OTHERCTXMID(first, last) first##GC##last
739	#endif
740
741	/** @def CTXALLMID
742	* Adds the current context as a middle name of an identifier name.
743	* The middle name is R3, R0 or GC.
744	*
745	* This is macro should only be used in shared code to avoid a forest of ifdefs.
746	* @param first First name.
747	* @param last Surname.
748	* @deprecated use CTX_MID or CTX_MID_Z
749	*/
750	#ifdef IN_RC
751	# define CTXALLMID(first, last) first##GC##last
752	#elif defined(IN_RING0)
753	# define CTXALLMID(first, last) first##R0##last
754	#else
755	# define CTXALLMID(first, last) first##R3##last
756	#endif
757
758	/** @def CTX_MID
759	* Adds the current context as a middle name of an identifier name.
760	* The middle name is R3, R0 or RC.
761	*
762	* This is macro should only be used in shared code to avoid a forest of ifdefs.
763	* @param first First name.
764	* @param last Surname.
765	*/
766	#ifdef IN_RC
767	# define CTX_MID(first, last) first##RC##last
768	#elif defined(IN_RING0)
769	# define CTX_MID(first, last) first##R0##last
770	#else
771	# define CTX_MID(first, last) first##R3##last
772	#endif
773
774	/** @def CTX_MID_Z
775	* Adds the current context as a middle name of an identifier name, combining RC
776	* and R0 into RZ.
777	* The middle name thus is either R3 or RZ.
778	*
779	* This is macro should only be used in shared code to avoid a forest of ifdefs.
780	* @param first First name.
781	* @param last Surname.
782	*/
783	#ifdef IN_RING3
784	# define CTX_MID_Z(first, last) first##R3##last
785	#else
786	# define CTX_MID_Z(first, last) first##RZ##last
787	#endif
788
789
790	/** @def R3STRING
791	* A macro which in GC and R0 will return a dummy string while in R3 it will return
792	* the parameter.
793	*
794	* This is typically used to wrap description strings in structures shared
795	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING3 mess.
796	*
797	* @param pR3String The R3 string. Only referenced in R3.
798	* @see R0STRING and GCSTRING
799	*/
800	#ifdef IN_RING3
801	# define R3STRING(pR3String) (pR3String)
802	#else
803	# define R3STRING(pR3String) ("<R3_STRING>")
804	#endif
805
806	/** @def R0STRING
807	* A macro which in GC and R3 will return a dummy string while in R0 it will return
808	* the parameter.
809	*
810	* This is typically used to wrap description strings in structures shared
811	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING0 mess.
812	*
813	* @param pR0String The R0 string. Only referenced in R0.
814	* @see R3STRING and GCSTRING
815	*/
816	#ifdef IN_RING0
817	# define R0STRING(pR0String) (pR0String)
818	#else
819	# define R0STRING(pR0String) ("<R0_STRING>")
820	#endif
821
822	/** @def RCSTRING
823	* A macro which in R3 and R0 will return a dummy string while in RC it will return
824	* the parameter.
825	*
826	* This is typically used to wrap description strings in structures shared
827	* between R3, R0 and/or RC. The intention is to avoid the \#ifdef IN_RC mess.
828	*
829	* @param pRCString The RC string. Only referenced in RC.
830	* @see R3STRING, R0STRING
831	*/
832	#ifdef IN_RC
833	# define RCSTRING(pRCString) (pRCString)
834	#else
835	# define RCSTRING(pRCString) ("<RC_STRING>")
836	#endif
837
838
839	/** @def RT_NOTHING
840	* A macro that expands to nothing.
841	* This is primarily intended as a dummy argument for macros to avoid the
842	* undefined behavior passing empty arguments to an macro (ISO C90 and C++98,
843	* gcc v4.4 warns about it).
844	*/
845	#define RT_NOTHING
846
847	/** @def RT_GCC_EXTENSION
848	* Macro for shutting up GCC warnings about using language extensions. */
849	#ifdef __GNUC__
850	# define RT_GCC_EXTENSION __extension__
851	#else
852	# define RT_GCC_EXTENSION
853	#endif
854
855	/** @def RT_COMPILER_GROKS_64BIT_BITFIELDS
856	* Macro that is defined if the compiler understands 64-bit bitfields. */
857	#if !defined(RT_OS_OS2) \|\| (!defined(__IBMC__) && !defined(__IBMCPP__))
858	# define RT_COMPILER_GROKS_64BIT_BITFIELDS
859	#endif
860
861	/** @def RT_COMPILER_WITH_80BIT_LONG_DOUBLE
862	* Macro that is defined if the compiler implements long double as the
863	* IEEE extended precision floating. */
864	#if (defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)) && !defined(RT_OS_WINDOWS)
865	# define RT_COMPILER_WITH_80BIT_LONG_DOUBLE
866	#endif
867
868
869	/** @def RT_EXCEPTIONS_ENABLED
870	* Defined when C++ exceptions are enabled.
871	*/
872	#if !defined(RT_EXCEPTIONS_ENABLED) \
873	&& defined(__cplusplus) \
874	&& ( (defined(_MSC_VER) && defined(_CPPUNWIND)) \
875	\|\| (defined(__GNUC__) && defined(__EXCEPTIONS)))
876	# define RT_EXCEPTIONS_ENABLED
877	#endif
878
879	/** @def RT_NO_THROW
880	* How to express that a function doesn't throw C++ exceptions
881	* and the compiler can thus save itself the bother of trying
882	* to catch any of them. Put this between the closing parenthesis
883	* and the semicolon in function prototypes (and implementation if C++).
884	*/
885	#ifdef RT_EXCEPTIONS_ENABLED
886	# define RT_NO_THROW throw()
887	#else
888	# define RT_NO_THROW
889	#endif
890
891	/** @def RT_THROW
892	* How to express that a method or function throws a type of exceptions. Some
893	* compilers does not want this kind of information and will warning about it.
894	*
895	* @param type The type exception.
896	*
897	* @remarks If the actual throwing is done from the header, enclose it by
898	* \#ifdef RT_EXCEPTIONS_ENABLED ... \#else ... \#endif so the header
899	* compiles cleanly without exceptions enabled.
900	*
901	* Do NOT use this for the actual throwing of exceptions!
902	*/
903	#ifdef RT_EXCEPTIONS_ENABLED
904	# ifdef _MSC_VER
905	# if _MSC_VER >= 1310
906	# define RT_THROW(type)
907	# else
908	# define RT_THROW(type) throw(type)
909	# endif
910	# else
911	# define RT_THROW(type) throw(type)
912	# endif
913	#else
914	# define RT_THROW(type)
915	#endif
916
917	/** @def RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
918	* Indicates that the "hidden" visibility attribute can be used (GCC) */
919	#if defined(__GNUC__)
920	# if __GNUC__ >= 4 && !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS)
921	# define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
922	# endif
923	#endif
924
925	/** @def RTCALL
926	* The standard calling convention for the Runtime interfaces.
927	*/
928	#ifdef _MSC_VER
929	# define RTCALL __cdecl
930	#elif defined(RT_OS_OS2)
931	# define RTCALL __cdecl
932	#elif defined(__GNUC__) && defined(IN_RING0) && defined(RT_ARCH_X86) /** @todo consider dropping IN_RING0 here. */
933	# define RTCALL __attribute__((cdecl,regparm(0))) /* regparm(0) deals with -mregparm=x use in the linux kernel. */
934	#else
935	# define RTCALL
936	#endif
937
938	/** @def DECLEXPORT
939	* How to declare an exported function.
940	* @param type The return type of the function declaration.
941	*/
942	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
943	# define DECLEXPORT(type) __declspec(dllexport) type
944	#elif defined(RT_USE_VISIBILITY_DEFAULT)
945	# define DECLEXPORT(type) __attribute__((visibility("default"))) type
946	#else
947	# define DECLEXPORT(type) type
948	#endif
949
950	/** @def DECLIMPORT
951	* How to declare an imported function.
952	* @param type The return type of the function declaration.
953	*/
954	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
955	# define DECLIMPORT(type) __declspec(dllimport) type
956	#else
957	# define DECLIMPORT(type) type
958	#endif
959
960	/** @def DECLHIDDEN
961	* How to declare a non-exported function or variable.
962	* @param type The return type of the function or the data type of the variable.
963	*/
964	#if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) \|\| defined(RT_NO_VISIBILITY_HIDDEN)
965	# define DECLHIDDEN(type) type
966	#else
967	# define DECLHIDDEN(type) __attribute__((visibility("hidden"))) type
968	#endif
969
970	/** @def DECL_HIDDEN_CONST
971	* Workaround for g++ warnings when applying the hidden attribute to a const
972	* definition. Use DECLHIDDEN for the declaration.
973	* @param a_Type The return type of the function or the data type of
974	* the variable.
975	*/
976	#if defined(__cplusplus) && defined(__GNUC__)
977	# define DECL_HIDDEN_CONST(a_Type) a_Type
978	#else
979	# define DECL_HIDDEN_CONST(a_Type) DECLHIDDEN(a_Type)
980	#endif
981
982	/** @def DECL_INVALID
983	* How to declare a function not available for linking in the current context.
984	* The purpose is to create compile or like time errors when used. This isn't
985	* possible on all platforms.
986	* @param type The return type of the function.
987	*/
988	#if defined(_MSC_VER)
989	# define DECL_INVALID(type) __declspec(dllimport) type __stdcall
990	#elif defined(__GNUC__) && defined(__cplusplus)
991	# define DECL_INVALID(type) extern "C++" type
992	#else
993	# define DECL_INVALID(type) type
994	#endif
995
996	/** @def DECLASM
997	* How to declare an internal assembly function.
998	* @param type The return type of the function declaration.
999	*/
1000	#ifdef __cplusplus
1001	# if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
1002	# define DECLASM(type) extern "C" type __cdecl
1003	# elif defined(__GNUC__) && defined(RT_ARCH_X86)
1004	# define DECLASM(type) extern "C" type __attribute__((cdecl,regparm(0)))
1005	# else
1006	# define DECLASM(type) extern "C" type
1007	# endif
1008	#else
1009	# if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
1010	# define DECLASM(type) type __cdecl
1011	# elif defined(__GNUC__) && defined(RT_ARCH_X86)
1012	# define DECLASM(type) type __attribute__((cdecl,regparm(0)))
1013	# else
1014	# define DECLASM(type) type
1015	# endif
1016	#endif
1017
1018	/** @def DECLASMTYPE
1019	* How to declare an internal assembly function type.
1020	* @param type The return type of the function.
1021	*/
1022	# if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
1023	# define DECLASMTYPE(type) type __cdecl
1024	#else
1025	# define DECLASMTYPE(type) type
1026	#endif
1027
1028	/** @def DECLNORETURN
1029	* How to declare a function which does not return.
1030	* @note: This macro can be combined with other macros, for example
1031	* @code
1032	* EMR3DECL(DECLNORETURN(void)) foo(void);
1033	* @endcode
1034	*/
1035	#ifdef _MSC_VER
1036	# define DECLNORETURN(type) __declspec(noreturn) type
1037	#elif defined(__GNUC__)
1038	# define DECLNORETURN(type) __attribute__((noreturn)) type
1039	#else
1040	# define DECLNORETURN(type) type
1041	#endif
1042
1043	/** @def DECLWEAK
1044	* How to declare a variable which is not necessarily resolved at
1045	* runtime.
1046	* @note: This macro can be combined with other macros, for example
1047	* @code
1048	* EMR3DECL(DECLWEAK(int)) foo;
1049	* @endcode
1050	*/
1051	#if defined(__GNUC__)
1052	# define DECLWEAK(type) type __attribute__((weak))
1053	#else
1054	# define DECLWEAK(type) type
1055	#endif
1056
1057	/** @def DECLCALLBACK
1058	* How to declare an call back function type.
1059	* @param type The return type of the function declaration.
1060	*/
1061	#define DECLCALLBACK(type) type RTCALL
1062
1063	/** @def DECLCALLBACKPTR
1064	* How to declare an call back function pointer.
1065	* @param type The return type of the function declaration.
1066	* @param name The name of the variable member.
1067	*/
1068	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
1069	# define DECLCALLBACKPTR(type, name) type (* RTCALL name)
1070	#else
1071	# define DECLCALLBACKPTR(type, name) type (RTCALL * name)
1072	#endif
1073
1074	/** @def DECLCALLBACKMEMBER
1075	* How to declare an call back function pointer member.
1076	* @param type The return type of the function declaration.
1077	* @param name The name of the struct/union/class member.
1078	*/
1079	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
1080	# define DECLCALLBACKMEMBER(type, name) type (* RTCALL name)
1081	#else
1082	# define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
1083	#endif
1084
1085	/** @def DECLR3CALLBACKMEMBER
1086	* How to declare an call back function pointer member - R3 Ptr.
1087	* @param type The return type of the function declaration.
1088	* @param name The name of the struct/union/class member.
1089	* @param args The argument list enclosed in parentheses.
1090	*/
1091	#ifdef IN_RING3
1092	# define DECLR3CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1093	#else
1094	# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
1095	#endif
1096
1097	/** @def DECLRCCALLBACKMEMBER
1098	* How to declare an call back function pointer member - RC Ptr.
1099	* @param type The return type of the function declaration.
1100	* @param name The name of the struct/union/class member.
1101	* @param args The argument list enclosed in parentheses.
1102	*/
1103	#ifdef IN_RC
1104	# define DECLRCCALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1105	#else
1106	# define DECLRCCALLBACKMEMBER(type, name, args) RTRCPTR name
1107	#endif
1108
1109	/** @def DECLR0CALLBACKMEMBER
1110	* How to declare an call back function pointer member - R0 Ptr.
1111	* @param type The return type of the function declaration.
1112	* @param name The name of the struct/union/class member.
1113	* @param args The argument list enclosed in parentheses.
1114	*/
1115	#ifdef IN_RING0
1116	# define DECLR0CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1117	#else
1118	# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
1119	#endif
1120
1121	/** @def DECLINLINE
1122	* How to declare a function as inline.
1123	* @param type The return type of the function declaration.
1124	* @remarks Don't use this macro on C++ methods.
1125	*/
1126	#ifdef __GNUC__
1127	# define DECLINLINE(type) static __inline__ type
1128	#elif defined(__cplusplus)
1129	# define DECLINLINE(type) inline type
1130	#elif defined(_MSC_VER)
1131	# define DECLINLINE(type) _inline type
1132	#elif defined(__IBMC__)
1133	# define DECLINLINE(type) _Inline type
1134	#else
1135	# define DECLINLINE(type) inline type
1136	#endif
1137
1138
1139	/** @def DECL_FORCE_INLINE
1140	* How to declare a function as inline and try convince the compiler to always
1141	* inline it regardless of optimization switches.
1142	* @param type The return type of the function declaration.
1143	* @remarks Use sparsely and with care. Don't use this macro on C++ methods.
1144	*/
1145	#ifdef __GNUC__
1146	# define DECL_FORCE_INLINE(type) __attribute__((__always_inline__)) DECLINLINE(type)
1147	#elif defined(_MSC_VER)
1148	# define DECL_FORCE_INLINE(type) __forceinline type
1149	#else
1150	# define DECL_FORCE_INLINE(type) DECLINLINE(type)
1151	#endif
1152
1153
1154	/** @def DECL_NO_INLINE
1155	* How to declare a function telling the compiler not to inline it.
1156	* @param scope The function scope, static or RT_NOTHING.
1157	* @param type The return type of the function declaration.
1158	* @remarks Don't use this macro on C++ methods.
1159	*/
1160	#ifdef __GNUC__
1161	# define DECL_NO_INLINE(scope,type) __attribute__((noinline)) scope type
1162	#elif defined(_MSC_VER)
1163	# define DECL_NO_INLINE(scope,type) __declspec(noinline) scope type
1164	#else
1165	# define DECL_NO_INLINE(scope,type) scope type
1166	#endif
1167
1168
1169	/** @def IN_RT_STATIC
1170	* Used to indicate whether we're linking against a static IPRT
1171	* or not. The IPRT symbols will be declared as hidden (if
1172	* supported). Note that this define has no effect without setting
1173	* IN_RT_R0, IN_RT_R3 or IN_RT_RC indicators are set first.
1174	*/
1175
1176	/** @def IN_RT_R0
1177	* Used to indicate whether we're inside the same link module as
1178	* the HC Ring-0 Runtime Library.
1179	*/
1180	/** @def RTR0DECL(type)
1181	* Runtime Library HC Ring-0 export or import declaration.
1182	* @param type The return type of the function declaration.
1183	*/
1184	#ifdef IN_RT_R0
1185	# ifdef IN_RT_STATIC
1186	# define RTR0DECL(type) DECLHIDDEN(type) RTCALL
1187	# else
1188	# define RTR0DECL(type) DECLEXPORT(type) RTCALL
1189	# endif
1190	#else
1191	# define RTR0DECL(type) DECLIMPORT(type) RTCALL
1192	#endif
1193
1194	/** @def IN_RT_R3
1195	* Used to indicate whether we're inside the same link module as
1196	* the HC Ring-3 Runtime Library.
1197	*/
1198	/** @def RTR3DECL(type)
1199	* Runtime Library HC Ring-3 export or import declaration.
1200	* @param type The return type of the function declaration.
1201	*/
1202	#ifdef IN_RT_R3
1203	# ifdef IN_RT_STATIC
1204	# define RTR3DECL(type) DECLHIDDEN(type) RTCALL
1205	# else
1206	# define RTR3DECL(type) DECLEXPORT(type) RTCALL
1207	# endif
1208	#else
1209	# define RTR3DECL(type) DECLIMPORT(type) RTCALL
1210	#endif
1211
1212	/** @def IN_RT_RC
1213	* Used to indicate whether we're inside the same link module as the raw-mode
1214	* context (RC) runtime library.
1215	*/
1216	/** @def RTRCDECL(type)
1217	* Runtime Library raw-mode context export or import declaration.
1218	* @param type The return type of the function declaration.
1219	*/
1220	#ifdef IN_RT_RC
1221	# ifdef IN_RT_STATIC
1222	# define RTRCDECL(type) DECLHIDDEN(type) RTCALL
1223	# else
1224	# define RTRCDECL(type) DECLEXPORT(type) RTCALL
1225	# endif
1226	#else
1227	# define RTRCDECL(type) DECLIMPORT(type) RTCALL
1228	#endif
1229
1230	/** @def RTDECL(type)
1231	* Runtime Library export or import declaration.
1232	* Functions declared using this macro exists in all contexts.
1233	* @param type The return type of the function declaration.
1234	*/
1235	#if defined(IN_RT_R3) \|\| defined(IN_RT_RC) \|\| defined(IN_RT_R0)
1236	# ifdef IN_RT_STATIC
1237	# define RTDECL(type) DECLHIDDEN(type) RTCALL
1238	# else
1239	# define RTDECL(type) DECLEXPORT(type) RTCALL
1240	# endif
1241	#else
1242	# define RTDECL(type) DECLIMPORT(type) RTCALL
1243	#endif
1244
1245	/** @def RTDATADECL(type)
1246	* Runtime Library export or import declaration.
1247	* Data declared using this macro exists in all contexts.
1248	* @param type The return type of the function declaration.
1249	*/
1250	#if defined(IN_RT_R3) \|\| defined(IN_RT_RC) \|\| defined(IN_RT_R0)
1251	# ifdef IN_RT_STATIC
1252	# define RTDATADECL(type) DECLHIDDEN(type)
1253	# else
1254	# define RTDATADECL(type) DECLEXPORT(type)
1255	# endif
1256	#else
1257	# define RTDATADECL(type) DECLIMPORT(type)
1258	#endif
1259
1260	/** @def RT_DECL_CLASS
1261	* Declares an class living in the runtime.
1262	*/
1263	#if defined(IN_RT_R3) \|\| defined(IN_RT_RC) \|\| defined(IN_RT_R0)
1264	# ifdef IN_RT_STATIC
1265	# define RT_DECL_CLASS
1266	# else
1267	# define RT_DECL_CLASS DECLEXPORT_CLASS
1268	# endif
1269	#else
1270	# define RT_DECL_CLASS DECLIMPORT_CLASS
1271	#endif
1272
1273
1274	/** @def RT_NOCRT
1275	* Symbol name wrapper for the No-CRT bits.
1276	*
1277	* In order to coexist in the same process as other CRTs, we need to
1278	* decorate the symbols such that they don't conflict the ones in the
1279	* other CRTs. The result of such conflicts / duplicate symbols can
1280	* confuse the dynamic loader on Unix like systems.
1281	*
1282	* Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
1283	* Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
1284	* wrapped names.
1285	*/
1286	/** @def RT_NOCRT_STR
1287	* Same as RT_NOCRT only it'll return a double quoted string of the result.
1288	*/
1289	#ifndef RT_WITHOUT_NOCRT_WRAPPERS
1290	# define RT_NOCRT(name) nocrt_ ## name
1291	# define RT_NOCRT_STR(name) "nocrt_" # name
1292	#else
1293	# define RT_NOCRT(name) name
1294	# define RT_NOCRT_STR(name) #name
1295	#endif
1296
1297
1298
1299	/** @def RT_LIKELY
1300	* Give the compiler a hint that an expression is very likely to hold true.
1301	*
1302	* Some compilers support explicit branch prediction so that the CPU backend
1303	* can hint the processor and also so that code blocks can be reordered such
1304	* that the predicted path sees a more linear flow, thus improving cache
1305	* behaviour, etc.
1306	*
1307	* IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
1308	* this compiler feature when present.
1309	*
1310	* A few notes about the usage:
1311	*
1312	* - Generally, use RT_UNLIKELY() with error condition checks (unless you
1313	* have some _strong_ reason to do otherwise, in which case document it),
1314	* and/or RT_LIKELY() with success condition checks, assuming you want
1315	* to optimize for the success path.
1316	*
1317	* - Other than that, if you don't know the likelihood of a test succeeding
1318	* from empirical or other 'hard' evidence, don't make predictions unless
1319	* you happen to be a Dirk Gently.
1320	*
1321	* - These macros are meant to be used in places that get executed a lot. It
1322	* is wasteful to make predictions in code that is executed rarely (e.g.
1323	* at subsystem initialization time) as the basic block reordering that this
1324	* affects can often generate larger code.
1325	*
1326	* - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
1327	* and RT_UNLIKELY(). Should you wish for prediction free status checks,
1328	* use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
1329	*
1330	*
1331	* @returns the boolean result of the expression.
1332	* @param expr The expression that's very likely to be true.
1333	* @see RT_UNLIKELY
1334	*/
1335	/** @def RT_UNLIKELY
1336	* Give the compiler a hint that an expression is highly unlikely to hold true.
1337	*
1338	* See the usage instructions give in the RT_LIKELY() docs.
1339	*
1340	* @returns the boolean result of the expression.
1341	* @param expr The expression that's very unlikely to be true.
1342	* @see RT_LIKELY
1343	*/
1344	#if defined(__GNUC__)
1345	# if __GNUC__ >= 3 && !defined(FORTIFY_RUNNING)
1346	# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
1347	# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
1348	# else
1349	# define RT_LIKELY(expr) (expr)
1350	# define RT_UNLIKELY(expr) (expr)
1351	# endif
1352	#else
1353	# define RT_LIKELY(expr) (expr)
1354	# define RT_UNLIKELY(expr) (expr)
1355	#endif
1356
1357
1358	/** @def RT_STR
1359	* Returns the argument as a string constant.
1360	* @param str Argument to stringify. */
1361	#define RT_STR(str) #str
1362	/** @def RT_XSTR
1363	* Returns the expanded argument as a string.
1364	* @param str Argument to expand and stringy. */
1365	#define RT_XSTR(str) RT_STR(str)
1366
1367	/** @def RT_CONCAT
1368	* Concatenate the expanded arguments without any extra spaces in between.
1369	*
1370	* @param a The first part.
1371	* @param b The second part.
1372	*/
1373	#define RT_CONCAT(a,b) RT_CONCAT_HLP(a,b)
1374	/** RT_CONCAT helper, don't use. */
1375	#define RT_CONCAT_HLP(a,b) a##b
1376
1377	/** @def RT_CONCAT
1378	* Concatenate the expanded arguments without any extra spaces in between.
1379	*
1380	* @param a The 1st part.
1381	* @param b The 2nd part.
1382	* @param c The 3rd part.
1383	*/
1384	#define RT_CONCAT3(a,b,c) RT_CONCAT3_HLP(a,b,c)
1385	/** RT_CONCAT3 helper, don't use. */
1386	#define RT_CONCAT3_HLP(a,b,c) a##b##c
1387
1388	/** @def RT_CONCAT
1389	* Concatenate the expanded arguments without any extra spaces in between.
1390	*
1391	* @param a The 1st part.
1392	* @param b The 2nd part.
1393	* @param c The 3rd part.
1394	*/
1395	#define RT_CONCAT4(a,b,c,d) RT_CONCAT4_HLP(a,b,c,d)
1396	/** RT_CONCAT4 helper, don't use. */
1397	#define RT_CONCAT4_HLP(a,b,c,d) a##b##c##d
1398
1399	/**
1400	* String constant tuple - string constant, strlen(string constant).
1401	*
1402	* @param a_szConst String constant.
1403	*/
1404	#define RT_STR_TUPLE(a_szConst) a_szConst, (sizeof(a_szConst) - 1)
1405
1406
1407	/**
1408	* Macro for using in switch statements that turns constants into strings.
1409	*
1410	* @param a_Const The constant (not string).
1411	*/
1412	#define RT_CASE_RET_STR(a_Const) case a_Const: return #a_Const
1413
1414
1415	/** @def RT_BIT
1416	* Convert a bit number into an integer bitmask (unsigned).
1417	* @param bit The bit number.
1418	*/
1419	#define RT_BIT(bit) ( 1U << (bit) )
1420
1421	/** @def RT_BIT_32
1422	* Convert a bit number into a 32-bit bitmask (unsigned).
1423	* @param bit The bit number.
1424	*/
1425	#define RT_BIT_32(bit) ( UINT32_C(1) << (bit) )
1426
1427	/** @def RT_BIT_64
1428	* Convert a bit number into a 64-bit bitmask (unsigned).
1429	* @param bit The bit number.
1430	*/
1431	#define RT_BIT_64(bit) ( UINT64_C(1) << (bit) )
1432
1433	/** @def RT_ALIGN
1434	* Align macro.
1435	* @param u Value to align.
1436	* @param uAlignment The alignment. Power of two!
1437	*
1438	* @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
1439	* When possible use any of the other RT_ALIGN_* macros. And when that's not
1440	* possible, make 101% sure that uAlignment is specified with a right sized type.
1441	*
1442	* Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
1443	* you a 32-bit return value!
1444	*
1445	* In short: Don't use this macro. Use RT_ALIGN_T() instead.
1446	*/
1447	#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
1448
1449	/** @def RT_ALIGN_T
1450	* Align macro.
1451	* @param u Value to align.
1452	* @param uAlignment The alignment. Power of two!
1453	* @param type Integer type to use while aligning.
1454	* @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
1455	*/
1456	#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
1457
1458	/** @def RT_ALIGN_32
1459	* Align macro for a 32-bit value.
1460	* @param u32 Value to align.
1461	* @param uAlignment The alignment. Power of two!
1462	*/
1463	#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
1464
1465	/** @def RT_ALIGN_64
1466	* Align macro for a 64-bit value.
1467	* @param u64 Value to align.
1468	* @param uAlignment The alignment. Power of two!
1469	*/
1470	#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
1471
1472	/** @def RT_ALIGN_Z
1473	* Align macro for size_t.
1474	* @param cb Value to align.
1475	* @param uAlignment The alignment. Power of two!
1476	*/
1477	#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
1478
1479	/** @def RT_ALIGN_P
1480	* Align macro for pointers.
1481	* @param pv Value to align.
1482	* @param uAlignment The alignment. Power of two!
1483	*/
1484	#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
1485
1486	/** @def RT_ALIGN_PT
1487	* Align macro for pointers with type cast.
1488	* @param u Value to align.
1489	* @param uAlignment The alignment. Power of two!
1490	* @param CastType The type to cast the result to.
1491	*/
1492	#define RT_ALIGN_PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, uintptr_t) )
1493
1494	/** @def RT_ALIGN_R3PT
1495	* Align macro for ring-3 pointers with type cast.
1496	* @param u Value to align.
1497	* @param uAlignment The alignment. Power of two!
1498	* @param CastType The type to cast the result to.
1499	*/
1500	#define RT_ALIGN_R3PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR) )
1501
1502	/** @def RT_ALIGN_R0PT
1503	* Align macro for ring-0 pointers with type cast.
1504	* @param u Value to align.
1505	* @param uAlignment The alignment. Power of two!
1506	* @param CastType The type to cast the result to.
1507	*/
1508	#define RT_ALIGN_R0PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR) )
1509
1510	/** @def RT_ALIGN_GCPT
1511	* Align macro for GC pointers with type cast.
1512	* @param u Value to align.
1513	* @param uAlignment The alignment. Power of two!
1514	* @param CastType The type to cast the result to.
1515	*/
1516	#define RT_ALIGN_GCPT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR) )
1517
1518
1519	/** @def RT_OFFSETOF
1520	* Our own special offsetof() variant, returns a signed result.
1521	*
1522	* This differs from the usual offsetof() in that it's not relying on builtin
1523	* compiler stuff and thus can use variables in arrays the structure may
1524	* contain. This is useful to determine the sizes of structures ending
1525	* with a variable length field.
1526	*
1527	* @returns offset into the structure of the specified member. signed.
1528	* @param type Structure type.
1529	* @param member Member.
1530	*/
1531	#define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type )(void )0)->member) )
1532
1533	/** @def RT_UOFFSETOF
1534	* Our own special offsetof() variant, returns an unsigned result.
1535	*
1536	* This differs from the usual offsetof() in that it's not relying on builtin
1537	* compiler stuff and thus can use variables in arrays the structure may
1538	* contain. This is useful to determine the sizes of structures ending
1539	* with a variable length field.
1540	*
1541	* @returns offset into the structure of the specified member. unsigned.
1542	* @param type Structure type.
1543	* @param member Member.
1544	*/
1545	#define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type )(void )0)->member) )
1546
1547	/** @def RT_OFFSETOF_ADD
1548	* RT_OFFSETOF with an addend.
1549	*
1550	* @returns offset into the structure of the specified member. signed.
1551	* @param type Structure type.
1552	* @param member Member.
1553	* @param addend The addend to add to the offset.
1554	*/
1555	#define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) )
1556
1557	/** @def RT_UOFFSETOF_ADD
1558	* RT_UOFFSETOF with an addend.
1559	*
1560	* @returns offset into the structure of the specified member. signed.
1561	* @param type Structure type.
1562	* @param member Member.
1563	* @param addend The addend to add to the offset.
1564	*/
1565	#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type )(void )(uintptr_t)(addend))->member) )
1566
1567	/** @def RT_SIZEOFMEMB
1568	* Get the size of a structure member.
1569	*
1570	* @returns size of the structure member.
1571	* @param type Structure type.
1572	* @param member Member.
1573	*/
1574	#define RT_SIZEOFMEMB(type, member) ( sizeof(((type )(void )0)->member) )
1575
1576	/** @def RT_FROM_MEMBER
1577	* Convert a pointer to a structure member into a pointer to the structure.
1578	*
1579	* @returns pointer to the structure.
1580	* @param pMem Pointer to the member.
1581	* @param Type Structure type.
1582	* @param Member Member name.
1583	*/
1584	#define RT_FROM_MEMBER(pMem, Type, Member) ( (Type ) ((uint8_t )(void *)(pMem) - RT_UOFFSETOF(Type, Member)) )
1585
1586	/** @def RT_FROM_CPP_MEMBER
1587	* Same as RT_FROM_MEMBER except it avoids the annoying g++ warnings about
1588	* invalid access to non-static data member of NULL object.
1589	*
1590	* @returns pointer to the structure.
1591	* @param pMem Pointer to the member.
1592	* @param Type Structure type.
1593	* @param Member Member name.
1594	*
1595	* @remarks Using the __builtin_offsetof does not shut up the compiler.
1596	*/
1597	#if defined(__GNUC__) && defined(__cplusplus)
1598	# define RT_FROM_CPP_MEMBER(pMem, Type, Member) \
1599	( (Type ) ((uintptr_t)(pMem) - (uintptr_t)&((Type )0x1000)->Member + 0x1000U) )
1600	#else
1601	# define RT_FROM_CPP_MEMBER(pMem, Type, Member) RT_FROM_MEMBER(pMem, Type, Member)
1602	#endif
1603
1604	/** @def RT_ELEMENTS
1605	* Calculates the number of elements in a statically sized array.
1606	* @returns Element count.
1607	* @param aArray Array in question.
1608	*/
1609	#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
1610
1611	/**
1612	* Checks if the value is a power of two.
1613	*
1614	* @returns true if power of two, false if not.
1615	* @param uVal The value to test.
1616	* @remarks 0 is a power of two.
1617	* @see VERR_NOT_POWER_OF_TWO
1618	*/
1619	#define RT_IS_POWER_OF_TWO(uVal) ( ((uVal) & ((uVal) - 1)) == 0)
1620
1621	#ifdef RT_OS_OS2
1622	/* Undefine RT_MAX since there is an unfortunate clash with the max
1623	resource type define in os2.h. */
1624	# undef RT_MAX
1625	#endif
1626
1627	/** @def RT_MAX
1628	* Finds the maximum value.
1629	* @returns The higher of the two.
1630	* @param Value1 Value 1
1631	* @param Value2 Value 2
1632	*/
1633	#define RT_MAX(Value1, Value2) ( (Value1) >= (Value2) ? (Value1) : (Value2) )
1634
1635	/** @def RT_MIN
1636	* Finds the minimum value.
1637	* @returns The lower of the two.
1638	* @param Value1 Value 1
1639	* @param Value2 Value 2
1640	*/
1641	#define RT_MIN(Value1, Value2) ( (Value1) <= (Value2) ? (Value1) : (Value2) )
1642
1643	/** @def RT_CLAMP
1644	* Clamps the value to minimum and maximum values.
1645	* @returns The clamped value.
1646	* @param Value The value to check.
1647	* @param Min Minimum value.
1648	* @param Max Maximum value.
1649	*/
1650	#define RT_CLAMP(Value, Min, Max) ( (Value) > (Max) ? (Max) : (Value) < (Min) ? (Min) : (Value) )
1651
1652	/** @def RT_ABS
1653	* Get the absolute (non-negative) value.
1654	* @returns The absolute value of Value.
1655	* @param Value The value.
1656	*/
1657	#define RT_ABS(Value) ( (Value) >= 0 ? (Value) : -(Value) )
1658
1659	/** @def RT_BOOL
1660	* Turn non-zero/zero into true/false
1661	* @returns The resulting boolean value.
1662	* @param Value The value.
1663	*/
1664	#define RT_BOOL(Value) ( !!(Value) )
1665
1666	/** @def RT_LO_U8
1667	* Gets the low uint8_t of a uint16_t or something equivalent. */
1668	#ifdef __GNUC__
1669	# define RT_LO_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)(a); })
1670	#else
1671	# define RT_LO_U8(a) ( (uint8_t)(a) )
1672	#endif
1673	/** @def RT_HI_U16
1674	* Gets the high uint16_t of a uint32_t or something equivalent). */
1675	#ifdef __GNUC__
1676	# define RT_HI_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)((a) >> 8); })
1677	#else
1678	# define RT_HI_U8(a) ( (uint8_t)((a) >> 8) )
1679	#endif
1680
1681	/** @def RT_LO_U16
1682	* Gets the low uint16_t of a uint32_t or something equivalent. */
1683	#ifdef __GNUC__
1684	# define RT_LO_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
1685	#else
1686	# define RT_LO_U16(a) ( (uint32_t)(a) )
1687	#endif
1688	/** @def RT_HI_U16
1689	* Gets the high uint16_t of a uint32_t or something equivalent). */
1690	#ifdef __GNUC__
1691	# define RT_HI_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)((a) >> 16); })
1692	#else
1693	# define RT_HI_U16(a) ( (uint16_t)((a) >> 16) )
1694	#endif
1695
1696	/** @def RT_LO_U32
1697	* Gets the low uint32_t of a uint64_t or something equivalent. */
1698	#ifdef __GNUC__
1699	# define RT_LO_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
1700	#else
1701	# define RT_LO_U32(a) ( (uint32_t)(a) )
1702	#endif
1703	/** @def RT_HI_U32
1704	* Gets the high uint32_t of a uint64_t or something equivalent). */
1705	#ifdef __GNUC__
1706	# define RT_HI_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)((a) >> 32); })
1707	#else
1708	# define RT_HI_U32(a) ( (uint32_t)((a) >> 32) )
1709	#endif
1710
1711	/** @def RT_BYTE1
1712	* Gets the first byte of something. */
1713	#define RT_BYTE1(a) ( (a) & 0xff )
1714	/** @def RT_BYTE2
1715	* Gets the second byte of something. */
1716	#define RT_BYTE2(a) ( ((a) >> 8) & 0xff )
1717	/** @def RT_BYTE3
1718	* Gets the second byte of something. */
1719	#define RT_BYTE3(a) ( ((a) >> 16) & 0xff )
1720	/** @def RT_BYTE4
1721	* Gets the fourth byte of something. */
1722	#define RT_BYTE4(a) ( ((a) >> 24) & 0xff )
1723	/** @def RT_BYTE5
1724	* Gets the fifth byte of something. */
1725	#define RT_BYTE5(a) ( ((a) >> 32) & 0xff )
1726	/** @def RT_BYTE6
1727	* Gets the sixth byte of something. */
1728	#define RT_BYTE6(a) ( ((a) >> 40) & 0xff )
1729	/** @def RT_BYTE7
1730	* Gets the seventh byte of something. */
1731	#define RT_BYTE7(a) ( ((a) >> 48) & 0xff )
1732	/** @def RT_BYTE8
1733	* Gets the eight byte of something. */
1734	#define RT_BYTE8(a) ( ((a) >> 56) & 0xff )
1735
1736
1737	/** @def RT_LODWORD
1738	* Gets the low dword (=uint32_t) of something.
1739	* @deprecated Use RT_LO_U32. */
1740	#define RT_LODWORD(a) ( (uint32_t)(a) )
1741	/** @def RT_HIDWORD
1742	* Gets the high dword (=uint32_t) of a 64-bit of something.
1743	* @deprecated Use RT_HI_U32. */
1744	#define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) )
1745
1746	/** @def RT_LOWORD
1747	* Gets the low word (=uint16_t) of something.
1748	* @deprecated Use RT_LO_U16. */
1749	#define RT_LOWORD(a) ( (a) & 0xffff )
1750	/** @def RT_HIWORD
1751	* Gets the high word (=uint16_t) of a 32-bit something.
1752	* @deprecated Use RT_HI_U16. */
1753	#define RT_HIWORD(a) ( (a) >> 16 )
1754
1755	/** @def RT_LOBYTE
1756	* Gets the low byte of something.
1757	* @deprecated Use RT_LO_U8. */
1758	#define RT_LOBYTE(a) ( (a) & 0xff )
1759	/** @def RT_HIBYTE
1760	* Gets the low byte of a 16-bit something.
1761	* @deprecated Use RT_HI_U8. */
1762	#define RT_HIBYTE(a) ( (a) >> 8 )
1763
1764
1765	/** @def RT_MAKE_U64
1766	* Constructs a uint64_t value from two uint32_t values.
1767	*/
1768	#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 \| (uint32_t)(Lo) )
1769
1770	/** @def RT_MAKE_U64_FROM_U16
1771	* Constructs a uint64_t value from four uint16_t values.
1772	*/
1773	#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
1774	((uint64_t)( (uint64_t)((uint16_t)(w3)) << 48 \
1775	\| (uint64_t)((uint16_t)(w2)) << 32 \
1776	\| (uint32_t)((uint16_t)(w1)) << 16 \
1777	\| (uint16_t)(w0) ))
1778
1779	/** @def RT_MAKE_U64_FROM_U8
1780	* Constructs a uint64_t value from eight uint8_t values.
1781	*/
1782	#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
1783	((uint64_t)( (uint64_t)((uint8_t)(b7)) << 56 \
1784	\| (uint64_t)((uint8_t)(b6)) << 48 \
1785	\| (uint64_t)((uint8_t)(b5)) << 40 \
1786	\| (uint64_t)((uint8_t)(b4)) << 32 \
1787	\| (uint32_t)((uint8_t)(b3)) << 24 \
1788	\| (uint32_t)((uint8_t)(b2)) << 16 \
1789	\| (uint16_t)((uint8_t)(b1)) << 8 \
1790	\| (uint8_t)(b0) ))
1791
1792	/** @def RT_MAKE_U32
1793	* Constructs a uint32_t value from two uint16_t values.
1794	*/
1795	#define RT_MAKE_U32(Lo, Hi) \
1796	((uint32_t)( (uint32_t)((uint16_t)(Hi)) << 16 \
1797	\| (uint16_t)(Lo) ))
1798
1799	/** @def RT_MAKE_U32_FROM_U8
1800	* Constructs a uint32_t value from four uint8_t values.
1801	*/
1802	#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
1803	((uint32_t)( (uint32_t)((uint8_t)(b3)) << 24 \
1804	\| (uint32_t)((uint8_t)(b2)) << 16 \
1805	\| (uint16_t)((uint8_t)(b1)) << 8 \
1806	\| (uint8_t)(b0) ))
1807
1808	/** @def RT_MAKE_U16
1809	* Constructs a uint16_t value from two uint8_t values.
1810	*/
1811	#define RT_MAKE_U16(Lo, Hi) \
1812	((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 \
1813	\| (uint8_t)(Lo) ))
1814
1815
1816	/** @def RT_BSWAP_U64
1817	* Reverses the byte order of an uint64_t value. */
1818	#if 0
1819	# define RT_BSWAP_U64(u64) RT_BSWAP_U64_C(u64)
1820	#elif defined(__GNUC__)
1821	# define RT_BSWAP_U64(u64) (__builtin_constant_p((u64)) \
1822	? RT_BSWAP_U64_C(u64) : ASMByteSwapU64(u64))
1823	#else
1824	# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
1825	#endif
1826
1827	/** @def RT_BSWAP_U32
1828	* Reverses the byte order of an uint32_t value. */
1829	#if 0
1830	# define RT_BSWAP_U32(u32) RT_BSWAP_U32_C(u32)
1831	#elif defined(__GNUC__)
1832	# define RT_BSWAP_U32(u32) (__builtin_constant_p((u32)) \
1833	? RT_BSWAP_U32_C(u32) : ASMByteSwapU32(u32))
1834	#else
1835	# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
1836	#endif
1837
1838	/** @def RT_BSWAP_U16
1839	* Reverses the byte order of an uint16_t value. */
1840	#if 0
1841	# define RT_BSWAP_U16(u16) RT_BSWAP_U16_C(u16)
1842	#elif defined(__GNUC__)
1843	# define RT_BSWAP_U16(u16) (__builtin_constant_p((u16)) \
1844	? RT_BSWAP_U16_C(u16) : ASMByteSwapU16(u16))
1845	#else
1846	# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
1847	#endif
1848
1849
1850	/** @def RT_BSWAP_U64_C
1851	* Reverses the byte order of an uint64_t constant. */
1852	#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
1853
1854	/** @def RT_BSWAP_U32_C
1855	* Reverses the byte order of an uint32_t constant. */
1856	#define RT_BSWAP_U32_C(u32) RT_MAKE_U32_FROM_U8(RT_BYTE4(u32), RT_BYTE3(u32), RT_BYTE2(u32), RT_BYTE1(u32))
1857
1858	/** @def RT_BSWAP_U16_C
1859	* Reverses the byte order of an uint16_t constant. */
1860	#define RT_BSWAP_U16_C(u16) RT_MAKE_U16(RT_HIBYTE(u16), RT_LOBYTE(u16))
1861
1862
1863	/** @def RT_H2LE_U64
1864	* Converts an uint64_t value from host to little endian byte order. */
1865	#ifdef RT_BIG_ENDIAN
1866	# define RT_H2LE_U64(u64) RT_BSWAP_U64(u64)
1867	#else
1868	# define RT_H2LE_U64(u64) (u64)
1869	#endif
1870
1871	/** @def RT_H2LE_U64_C
1872	* Converts an uint64_t constant from host to little endian byte order. */
1873	#ifdef RT_BIG_ENDIAN
1874	# define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64)
1875	#else
1876	# define RT_H2LE_U64_C(u64) (u64)
1877	#endif
1878
1879	/** @def RT_H2LE_U32
1880	* Converts an uint32_t value from host to little endian byte order. */
1881	#ifdef RT_BIG_ENDIAN
1882	# define RT_H2LE_U32(u32) RT_BSWAP_U32(u32)
1883	#else
1884	# define RT_H2LE_U32(u32) (u32)
1885	#endif
1886
1887	/** @def RT_H2LE_U32_C
1888	* Converts an uint32_t constant from host to little endian byte order. */
1889	#ifdef RT_BIG_ENDIAN
1890	# define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32)
1891	#else
1892	# define RT_H2LE_U32_C(u32) (u32)
1893	#endif
1894
1895	/** @def RT_H2LE_U16
1896	* Converts an uint16_t value from host to little endian byte order. */
1897	#ifdef RT_BIG_ENDIAN
1898	# define RT_H2LE_U16(u16) RT_BSWAP_U16(u16)
1899	#else
1900	# define RT_H2LE_U16(u16) (u16)
1901	#endif
1902
1903	/** @def RT_H2LE_U16_C
1904	* Converts an uint16_t constant from host to little endian byte order. */
1905	#ifdef RT_BIG_ENDIAN
1906	# define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16)
1907	#else
1908	# define RT_H2LE_U16_C(u16) (u16)
1909	#endif
1910
1911
1912	/** @def RT_LE2H_U64
1913	* Converts an uint64_t value from little endian to host byte order. */
1914	#ifdef RT_BIG_ENDIAN
1915	# define RT_LE2H_U64(u64) RT_BSWAP_U64(u64)
1916	#else
1917	# define RT_LE2H_U64(u64) (u64)
1918	#endif
1919
1920	/** @def RT_LE2H_U64_C
1921	* Converts an uint64_t constant from little endian to host byte order. */
1922	#ifdef RT_BIG_ENDIAN
1923	# define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
1924	#else
1925	# define RT_LE2H_U64_C(u64) (u64)
1926	#endif
1927
1928	/** @def RT_LE2H_U32
1929	* Converts an uint32_t value from little endian to host byte order. */
1930	#ifdef RT_BIG_ENDIAN
1931	# define RT_LE2H_U32(u32) RT_BSWAP_U32(u32)
1932	#else
1933	# define RT_LE2H_U32(u32) (u32)
1934	#endif
1935
1936	/** @def RT_LE2H_U32_C
1937	* Converts an uint32_t constant from little endian to host byte order. */
1938	#ifdef RT_BIG_ENDIAN
1939	# define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
1940	#else
1941	# define RT_LE2H_U32_C(u32) (u32)
1942	#endif
1943
1944	/** @def RT_LE2H_U16
1945	* Converts an uint16_t value from little endian to host byte order. */
1946	#ifdef RT_BIG_ENDIAN
1947	# define RT_LE2H_U16(u16) RT_BSWAP_U16(u16)
1948	#else
1949	# define RT_LE2H_U16(u16) (u16)
1950	#endif
1951
1952	/** @def RT_LE2H_U16_C
1953	* Converts an uint16_t constant from little endian to host byte order. */
1954	#ifdef RT_BIG_ENDIAN
1955	# define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
1956	#else
1957	# define RT_LE2H_U16_C(u16) (u16)
1958	#endif
1959
1960
1961	/** @def RT_H2BE_U64
1962	* Converts an uint64_t value from host to big endian byte order. */
1963	#ifdef RT_BIG_ENDIAN
1964	# define RT_H2BE_U64(u64) (u64)
1965	#else
1966	# define RT_H2BE_U64(u64) RT_BSWAP_U64(u64)
1967	#endif
1968
1969	/** @def RT_H2BE_U64_C
1970	* Converts an uint64_t constant from host to big endian byte order. */
1971	#ifdef RT_BIG_ENDIAN
1972	# define RT_H2BE_U64_C(u64) (u64)
1973	#else
1974	# define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64)
1975	#endif
1976
1977	/** @def RT_H2BE_U32
1978	* Converts an uint32_t value from host to big endian byte order. */
1979	#ifdef RT_BIG_ENDIAN
1980	# define RT_H2BE_U32(u32) (u32)
1981	#else
1982	# define RT_H2BE_U32(u32) RT_BSWAP_U32(u32)
1983	#endif
1984
1985	/** @def RT_H2BE_U32_C
1986	* Converts an uint32_t constant from host to big endian byte order. */
1987	#ifdef RT_BIG_ENDIAN
1988	# define RT_H2BE_U32_C(u32) (u32)
1989	#else
1990	# define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32)
1991	#endif
1992
1993	/** @def RT_H2BE_U16
1994	* Converts an uint16_t value from host to big endian byte order. */
1995	#ifdef RT_BIG_ENDIAN
1996	# define RT_H2BE_U16(u16) (u16)
1997	#else
1998	# define RT_H2BE_U16(u16) RT_BSWAP_U16(u16)
1999	#endif
2000
2001	/** @def RT_H2BE_U16_C
2002	* Converts an uint16_t constant from host to big endian byte order. */
2003	#ifdef RT_BIG_ENDIAN
2004	# define RT_H2BE_U16_C(u16) (u16)
2005	#else
2006	# define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16)
2007	#endif
2008
2009	/** @def RT_BE2H_U64
2010	* Converts an uint64_t value from big endian to host byte order. */
2011	#ifdef RT_BIG_ENDIAN
2012	# define RT_BE2H_U64(u64) (u64)
2013	#else
2014	# define RT_BE2H_U64(u64) RT_BSWAP_U64(u64)
2015	#endif
2016
2017	/** @def RT_BE2H_U64
2018	* Converts an uint64_t constant from big endian to host byte order. */
2019	#ifdef RT_BIG_ENDIAN
2020	# define RT_BE2H_U64_C(u64) (u64)
2021	#else
2022	# define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
2023	#endif
2024
2025	/** @def RT_BE2H_U32
2026	* Converts an uint32_t value from big endian to host byte order. */
2027	#ifdef RT_BIG_ENDIAN
2028	# define RT_BE2H_U32(u32) (u32)
2029	#else
2030	# define RT_BE2H_U32(u32) RT_BSWAP_U32(u32)
2031	#endif
2032
2033	/** @def RT_BE2H_U32_C
2034	* Converts an uint32_t value from big endian to host byte order. */
2035	#ifdef RT_BIG_ENDIAN
2036	# define RT_BE2H_U32_C(u32) (u32)
2037	#else
2038	# define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
2039	#endif
2040
2041	/** @def RT_BE2H_U16
2042	* Converts an uint16_t value from big endian to host byte order. */
2043	#ifdef RT_BIG_ENDIAN
2044	# define RT_BE2H_U16(u16) (u16)
2045	#else
2046	# define RT_BE2H_U16(u16) RT_BSWAP_U16(u16)
2047	#endif
2048
2049	/** @def RT_BE2H_U16_C
2050	* Converts an uint16_t constant from big endian to host byte order. */
2051	#ifdef RT_BIG_ENDIAN
2052	# define RT_BE2H_U16_C(u16) (u16)
2053	#else
2054	# define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2055	#endif
2056
2057
2058	/** @def RT_H2N_U64
2059	* Converts an uint64_t value from host to network byte order. */
2060	#define RT_H2N_U64(u64) RT_H2BE_U64(u64)
2061
2062	/** @def RT_H2N_U64_C
2063	* Converts an uint64_t constant from host to network byte order. */
2064	#define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64)
2065
2066	/** @def RT_H2N_U32
2067	* Converts an uint32_t value from host to network byte order. */
2068	#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
2069
2070	/** @def RT_H2N_U32_C
2071	* Converts an uint32_t constant from host to network byte order. */
2072	#define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32)
2073
2074	/** @def RT_H2N_U16
2075	* Converts an uint16_t value from host to network byte order. */
2076	#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
2077
2078	/** @def RT_H2N_U16_C
2079	* Converts an uint16_t constant from host to network byte order. */
2080	#define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16)
2081
2082	/** @def RT_N2H_U64
2083	* Converts an uint64_t value from network to host byte order. */
2084	#define RT_N2H_U64(u64) RT_BE2H_U64(u64)
2085
2086	/** @def RT_N2H_U64_C
2087	* Converts an uint64_t constant from network to host byte order. */
2088	#define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64)
2089
2090	/** @def RT_N2H_U32
2091	* Converts an uint32_t value from network to host byte order. */
2092	#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
2093
2094	/** @def RT_N2H_U32_C
2095	* Converts an uint32_t constant from network to host byte order. */
2096	#define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32)
2097
2098	/** @def RT_N2H_U16
2099	* Converts an uint16_t value from network to host byte order. */
2100	#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
2101
2102	/** @def RT_N2H_U16_C
2103	* Converts an uint16_t value from network to host byte order. */
2104	#define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16)
2105
2106
2107	/*
2108	* The BSD sys/param.h + machine/param.h file is a major source of
2109	* namespace pollution. Kill off some of the worse ones unless we're
2110	* compiling kernel code.
2111	*/
2112	#if defined(RT_OS_DARWIN) \
2113	&& !defined(KERNEL) \
2114	&& !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
2115	&& ( defined(_SYS_PARAM_H_) \|\| defined(_I386_PARAM_H_) )
2116	/* sys/param.h: */
2117	# undef PSWP
2118	# undef PVM
2119	# undef PINOD
2120	# undef PRIBO
2121	# undef PVFS
2122	# undef PZERO
2123	# undef PSOCK
2124	# undef PWAIT
2125	# undef PLOCK
2126	# undef PPAUSE
2127	# undef PUSER
2128	# undef PRIMASK
2129	# undef MINBUCKET
2130	# undef MAXALLOCSAVE
2131	# undef FSHIFT
2132	# undef FSCALE
2133
2134	/* i386/machine.h: */
2135	# undef ALIGN
2136	# undef ALIGNBYTES
2137	# undef DELAY
2138	# undef STATUS_WORD
2139	# undef USERMODE
2140	# undef BASEPRI
2141	# undef MSIZE
2142	# undef CLSIZE
2143	# undef CLSIZELOG2
2144	#endif
2145
2146	/** @def NIL_OFFSET
2147	* NIL offset.
2148	* Whenever we use offsets instead of pointers to save space and relocation effort
2149	* NIL_OFFSET shall be used as the equivalent to NULL.
2150	*/
2151	#define NIL_OFFSET (~0U)
2152
2153	/** @def NOREF
2154	* Keeps the compiler from bitching about an unused parameter.
2155	*/
2156	#define NOREF(var) (void)(var)
2157
2158	/** @def RT_BREAKPOINT
2159	* Emit a debug breakpoint instruction.
2160	*
2161	* @remarks In the x86/amd64 gnu world we add a nop instruction after the int3
2162	* to force gdb to remain at the int3 source line.
2163	* @remarks The L4 kernel will try make sense of the breakpoint, thus the jmp on
2164	* x86/amd64.
2165	*/
2166	#ifdef __GNUC__
2167	# if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
2168	# if !defined(__L4ENV__)
2169	# define RT_BREAKPOINT() __asm__ __volatile__("int $3\n\tnop\n\t")
2170	# else
2171	# define RT_BREAKPOINT() __asm__ __volatile__("int3; jmp 1f; 1:\n\t")
2172	# endif
2173	# elif defined(RT_ARCH_SPARC64)
2174	# define RT_BREAKPOINT() __asm__ __volatile__("illtrap 0\n\t") /** @todo Sparc64: this is just a wild guess. */
2175	# elif defined(RT_ARCH_SPARC)
2176	# define RT_BREAKPOINT() __asm__ __volatile__("unimp 0\n\t") /** @todo Sparc: this is just a wild guess (same as Sparc64, just different name). */
2177	# endif
2178	#endif
2179	#ifdef _MSC_VER
2180	# define RT_BREAKPOINT() __debugbreak()
2181	#endif
2182	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
2183	# define RT_BREAKPOINT() __interrupt(3)
2184	#endif
2185	#ifndef RT_BREAKPOINT
2186	# error "This compiler/arch is not supported!"
2187	#endif
2188
2189
2190	/** @defgroup grp_rt_cdefs_size Size Constants
2191	* (Of course, these are binary computer terms, not SI.)
2192	* @{
2193	*/
2194	/** 1 K (Kilo) (1 024). */
2195	#define _1K 0x00000400
2196	/** 2 K (Kilo) (2 048). */
2197	#define _2K 0x00000800
2198	/** 4 K (Kilo) (4 096). */
2199	#define _4K 0x00001000
2200	/** 8 K (Kilo) (8 192). */
2201	#define _8K 0x00002000
2202	/** 16 K (Kilo) (16 384). */
2203	#define _16K 0x00004000
2204	/** 32 K (Kilo) (32 678). */
2205	#define _32K 0x00008000
2206	/** 64 K (Kilo) (65 536). */
2207	#define _64K 0x00010000
2208	/** 128 K (Kilo) (131 072). */
2209	#define _128K 0x00020000
2210	/** 256 K (Kilo) (262 144). */
2211	#define _256K 0x00040000
2212	/** 512 K (Kilo) (524 288). */
2213	#define _512K 0x00080000
2214	/** 1 M (Mega) (1 048 576). */
2215	#define _1M 0x00100000
2216	/** 2 M (Mega) (2 097 152). */
2217	#define _2M 0x00200000
2218	/** 4 M (Mega) (4 194 304). */
2219	#define _4M 0x00400000
2220	/** 1 G (Giga) (1 073 741 824). (32-bit) */
2221	#define _1G 0x40000000
2222	/** 1 G (Giga) (1 073 741 824). (64-bit) */
2223	#define _1G64 0x40000000LL
2224	/** 2 G (Giga) (2 147 483 648). (32-bit) */
2225	#define _2G32 0x80000000U
2226	/** 2 G (Giga) (2 147 483 648). (64-bit) */
2227	#define _2G 0x0000000080000000LL
2228	/** 4 G (Giga) (4 294 967 296). */
2229	#define _4G 0x0000000100000000LL
2230	/** 1 T (Tera) (1 099 511 627 776). */
2231	#define _1T 0x0000010000000000LL
2232	/** 1 P (Peta) (1 125 899 906 842 624). */
2233	#define _1P 0x0004000000000000LL
2234	/** 1 E (Exa) (1 152 921 504 606 846 976). */
2235	#define _1E 0x1000000000000000LL
2236	/** 2 E (Exa) (2 305 843 009 213 693 952). */
2237	#define _2E 0x2000000000000000ULL
2238	/** @} */
2239
2240	/** @defgroup grp_rt_cdefs_decimal_grouping Decimal Constant Grouping Macros
2241	* @{ */
2242	#define RT_D1(g1) g1
2243	#define RT_D2(g1, g2) g1#g2
2244	#define RT_D3(g1, g2, g3) g1#g2#g3
2245	#define RT_D4(g1, g2, g3, g4) g1#g2#g3#g4
2246	#define RT_D5(g1, g2, g3, g4, g5) g1#g2#g3#g4#g5
2247	#define RT_D6(g1, g2, g3, g4, g5, g6) g1#g2#g3#g4#g5#g6
2248	#define RT_D7(g1, g2, g3, g4, g5, g6, g7) g1#g2#g3#g4#g5#g6#g7
2249
2250	#define RT_D1_U(g1) UINT32_C(g1)
2251	#define RT_D2_U(g1, g2) UINT32_C(g1#g2)
2252	#define RT_D3_U(g1, g2, g3) UINT32_C(g1#g2#g3)
2253	#define RT_D4_U(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2254	#define RT_D5_U(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2255	#define RT_D6_U(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2256	#define RT_D7_U(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2257
2258	#define RT_D1_S(g1) INT32_C(g1)
2259	#define RT_D2_S(g1, g2) INT32_C(g1#g2)
2260	#define RT_D3_S(g1, g2, g3) INT32_C(g1#g2#g3)
2261	#define RT_D4_S(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2262	#define RT_D5_S(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2263	#define RT_D6_S(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2264	#define RT_D7_S(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2265
2266	#define RT_D1_U32(g1) UINT32_C(g1)
2267	#define RT_D2_U32(g1, g2) UINT32_C(g1#g2)
2268	#define RT_D3_U32(g1, g2, g3) UINT32_C(g1#g2#g3)
2269	#define RT_D4_U32(g1, g2, g3, g4) UINT32_C(g1#g2#g3#g4)
2270
2271	#define RT_D1_S32(g1) INT32_C(g1)
2272	#define RT_D2_S32(g1, g2) INT32_C(g1#g2)
2273	#define RT_D3_S32(g1, g2, g3) INT32_C(g1#g2#g3)
2274	#define RT_D4_S32(g1, g2, g3, g4) INT32_C(g1#g2#g3#g4)
2275
2276	#define RT_D1_U64(g1) UINT64_C(g1)
2277	#define RT_D2_U64(g1, g2) UINT64_C(g1#g2)
2278	#define RT_D3_U64(g1, g2, g3) UINT64_C(g1#g2#g3)
2279	#define RT_D4_U64(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2280	#define RT_D5_U64(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2281	#define RT_D6_U64(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2282	#define RT_D7_U64(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2283
2284	#define RT_D1_S64(g1) INT64_C(g1)
2285	#define RT_D2_S64(g1, g2) INT64_C(g1#g2)
2286	#define RT_D3_S64(g1, g2, g3) INT64_C(g1#g2#g3)
2287	#define RT_D4_S64(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2288	#define RT_D5_S64(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2289	#define RT_D6_S64(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2290	#define RT_D7_S64(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2291	/** @} */
2292
2293
2294	/** @defgroup grp_rt_cdefs_time Time Constants
2295	* @{
2296	*/
2297	/** 1 hour expressed in nanoseconds (64-bit). */
2298	#define RT_NS_1HOUR UINT64_C(3600000000000)
2299	/** 1 minute expressed in nanoseconds (64-bit). */
2300	#define RT_NS_1MIN UINT64_C(60000000000)
2301	/** 45 second expressed in nanoseconds. */
2302	#define RT_NS_45SEC UINT64_C(45000000000)
2303	/** 30 second expressed in nanoseconds. */
2304	#define RT_NS_30SEC UINT64_C(30000000000)
2305	/** 20 second expressed in nanoseconds. */
2306	#define RT_NS_20SEC UINT64_C(20000000000)
2307	/** 15 second expressed in nanoseconds. */
2308	#define RT_NS_15SEC UINT64_C(15000000000)
2309	/** 10 second expressed in nanoseconds. */
2310	#define RT_NS_10SEC UINT64_C(10000000000)
2311	/** 1 second expressed in nanoseconds. */
2312	#define RT_NS_1SEC UINT32_C(1000000000)
2313	/** 100 millsecond expressed in nanoseconds. */
2314	#define RT_NS_100MS UINT32_C(100000000)
2315	/** 10 millsecond expressed in nanoseconds. */
2316	#define RT_NS_10MS UINT32_C(10000000)
2317	/** 1 millsecond expressed in nanoseconds. */
2318	#define RT_NS_1MS UINT32_C(1000000)
2319	/** 100 microseconds expressed in nanoseconds. */
2320	#define RT_NS_100US UINT32_C(100000)
2321	/** 10 microseconds expressed in nanoseconds. */
2322	#define RT_NS_10US UINT32_C(10000)
2323	/** 1 microsecond expressed in nanoseconds. */
2324	#define RT_NS_1US UINT32_C(1000)
2325
2326	/** 1 second expressed in nanoseconds - 64-bit type. */
2327	#define RT_NS_1SEC_64 UINT64_C(1000000000)
2328	/** 100 millsecond expressed in nanoseconds - 64-bit type. */
2329	#define RT_NS_100MS_64 UINT64_C(100000000)
2330	/** 10 millsecond expressed in nanoseconds - 64-bit type. */
2331	#define RT_NS_10MS_64 UINT64_C(10000000)
2332	/** 1 millsecond expressed in nanoseconds - 64-bit type. */
2333	#define RT_NS_1MS_64 UINT64_C(1000000)
2334	/** 100 microseconds expressed in nanoseconds - 64-bit type. */
2335	#define RT_NS_100US_64 UINT64_C(100000)
2336	/** 10 microseconds expressed in nanoseconds - 64-bit type. */
2337	#define RT_NS_10US_64 UINT64_C(10000)
2338	/** 1 microsecond expressed in nanoseconds - 64-bit type. */
2339	#define RT_NS_1US_64 UINT64_C(1000)
2340
2341	/** 1 hour expressed in microseconds. */
2342	#define RT_US_1HOUR UINT32_C(3600000000)
2343	/** 1 minute expressed in microseconds. */
2344	#define RT_US_1MIN UINT32_C(60000000)
2345	/** 1 second expressed in microseconds. */
2346	#define RT_US_1SEC UINT32_C(1000000)
2347	/** 100 millsecond expressed in microseconds. */
2348	#define RT_US_100MS UINT32_C(100000)
2349	/** 10 millsecond expressed in microseconds. */
2350	#define RT_US_10MS UINT32_C(10000)
2351	/** 1 millsecond expressed in microseconds. */
2352	#define RT_US_1MS UINT32_C(1000)
2353
2354	/** 1 hour expressed in microseconds - 64-bit type. */
2355	#define RT_US_1HOUR_64 UINT64_C(3600000000)
2356	/** 1 minute expressed in microseconds - 64-bit type. */
2357	#define RT_US_1MIN_64 UINT64_C(60000000)
2358	/** 1 second expressed in microseconds - 64-bit type. */
2359	#define RT_US_1SEC_64 UINT64_C(1000000)
2360	/** 100 millsecond expressed in microseconds - 64-bit type. */
2361	#define RT_US_100MS_64 UINT64_C(100000)
2362	/** 10 millsecond expressed in microseconds - 64-bit type. */
2363	#define RT_US_10MS_64 UINT64_C(10000)
2364	/** 1 millsecond expressed in microseconds - 64-bit type. */
2365	#define RT_US_1MS_64 UINT64_C(1000)
2366
2367	/** 1 hour expressed in milliseconds. */
2368	#define RT_MS_1HOUR UINT32_C(3600000)
2369	/** 1 minute expressed in milliseconds. */
2370	#define RT_MS_1MIN UINT32_C(60000)
2371	/** 1 second expressed in milliseconds. */
2372	#define RT_MS_1SEC UINT32_C(1000)
2373
2374	/** 1 hour expressed in milliseconds - 64-bit type. */
2375	#define RT_MS_1HOUR_64 UINT64_C(3600000)
2376	/** 1 minute expressed in milliseconds - 64-bit type. */
2377	#define RT_MS_1MIN_64 UINT64_C(60000)
2378	/** 1 second expressed in milliseconds - 64-bit type. */
2379	#define RT_MS_1SEC_64 UINT64_C(1000)
2380
2381	/** The number of seconds per week. */
2382	#define RT_SEC_1WEEK UINT32_C(604800)
2383	/** The number of seconds per day. */
2384	#define RT_SEC_1DAY UINT32_C(86400)
2385	/** The number of seconds per hour. */
2386	#define RT_SEC_1HOUR UINT32_C(3600)
2387
2388	/** The number of seconds per week - 64-bit type. */
2389	#define RT_SEC_1WEEK_64 UINT64_C(604800)
2390	/** The number of seconds per day - 64-bit type. */
2391	#define RT_SEC_1DAY_64 UINT64_C(86400)
2392	/** The number of seconds per hour - 64-bit type. */
2393	#define RT_SEC_1HOUR_64 UINT64_C(3600)
2394	/** @} */
2395
2396
2397	/** @defgroup grp_rt_cdefs_dbgtype Debug Info Types
2398	* @{ */
2399	/** Other format. */
2400	#define RT_DBGTYPE_OTHER RT_BIT_32(0)
2401	/** Stabs. */
2402	#define RT_DBGTYPE_STABS RT_BIT_32(1)
2403	/** Debug With Arbitrary Record Format (DWARF). */
2404	#define RT_DBGTYPE_DWARF RT_BIT_32(2)
2405	/** Microsoft Codeview debug info. */
2406	#define RT_DBGTYPE_CODEVIEW RT_BIT_32(3)
2407	/** Watcom debug info. */
2408	#define RT_DBGTYPE_WATCOM RT_BIT_32(4)
2409	/** IBM High Level Language debug info. */
2410	#define RT_DBGTYPE_HLL RT_BIT_32(5)
2411	/** Old OS/2 and Windows symbol file. */
2412	#define RT_DBGTYPE_SYM RT_BIT_32(6)
2413	/** Map file. */
2414	#define RT_DBGTYPE_MAP RT_BIT_32(7)
2415	/** @} */
2416
2417
2418	/** @defgroup grp_rt_cdefs_exetype Executable Image Types
2419	* @{ */
2420	/** Some other format. */
2421	#define RT_EXETYPE_OTHER RT_BIT_32(0)
2422	/** Portable Executable. */
2423	#define RT_EXETYPE_PE RT_BIT_32(1)
2424	/** Linear eXecutable. */
2425	#define RT_EXETYPE_LX RT_BIT_32(2)
2426	/** Linear Executable. */
2427	#define RT_EXETYPE_LE RT_BIT_32(3)
2428	/** New Executable. */
2429	#define RT_EXETYPE_NE RT_BIT_32(4)
2430	/** DOS Executable (Mark Zbikowski). */
2431	#define RT_EXETYPE_MZ RT_BIT_32(5)
2432	/** COM Executable. */
2433	#define RT_EXETYPE_COM RT_BIT_32(6)
2434	/** a.out Executable. */
2435	#define RT_EXETYPE_AOUT RT_BIT_32(7)
2436	/** Executable and Linkable Format. */
2437	#define RT_EXETYPE_ELF RT_BIT_32(8)
2438	/** Mach-O Executable (including FAT ones). */
2439	#define RT_EXETYPE_MACHO RT_BIT_32(9)
2440	/** TE from UEFI. */
2441	#define RT_EXETYPE_TE RT_BIT_32(9)
2442	/** @} */
2443
2444
2445	/** @def VALID_PTR
2446	* Pointer validation macro.
2447	* @param ptr The pointer.
2448	*/
2449	#if defined(RT_ARCH_AMD64)
2450	# ifdef IN_RING3
2451	# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
2452	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
2453	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
2454	# elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */
2455	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
2456	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
2457	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
2458	# else
2459	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
2460	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
2461	# endif
2462	# else /* !IN_RING3 */
2463	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
2464	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
2465	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
2466	# endif /* !IN_RING3 */
2467
2468	#elif defined(RT_ARCH_X86)
2469	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
2470
2471	#elif defined(RT_ARCH_SPARC64)
2472	# ifdef IN_RING3
2473	# if defined(RT_OS_SOLARIS)
2474	/** Sparc64 user mode: According to Figure 9.4 in solaris internals */
2475	/** @todo # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80004000U >= 0x80004000U + 0x100000000ULL ) - figure this. */
2476	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80000000U >= 0x80000000U + 0x100000000ULL )
2477	# else
2478	# error "Port me"
2479	# endif
2480	# else /* !IN_RING3 */
2481	# if defined(RT_OS_SOLARIS)
2482	/** @todo Sparc64 kernel mode: This is according to Figure 11.1 in solaris
2483	* internals. Verify in sources. */
2484	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x01000000U )
2485	# else
2486	# error "Port me"
2487	# endif
2488	# endif /* !IN_RING3 */
2489
2490	#elif defined(RT_ARCH_SPARC)
2491	# ifdef IN_RING3
2492	# ifdef RT_OS_SOLARIS
2493	/** Sparc user mode: According to
2494	* http://cvs.opensolaris.org/source/xref/onnv/onnv-gate/usr/src/uts/sun4/os/startup.c#510 */
2495	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x400000U >= 0x400000U + 0x2000U )
2496
2497	# else
2498	# error "Port me"
2499	# endif
2500	# else /* !IN_RING3 */
2501	# ifdef RT_OS_SOLARIS
2502	/** @todo Sparc kernel mode: Check the sources! */
2503	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
2504	# else
2505	# error "Port me"
2506	# endif
2507	# endif /* !IN_RING3 */
2508
2509	#elif defined(RT_ARCH_ARM)
2510	/* ASSUMES that at least the last and first 4K are out of bounds. */
2511	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
2512
2513	#else
2514	# error "Architecture identifier missing / not implemented."
2515	#endif
2516
2517	/** Old name for RT_VALID_PTR. */
2518	#define VALID_PTR(ptr) RT_VALID_PTR(ptr)
2519
2520	/** @def RT_VALID_ALIGNED_PTR
2521	* Pointer validation macro that also checks the alignment.
2522	* @param ptr The pointer.
2523	* @param align The alignment, must be a power of two.
2524	*/
2525	#define RT_VALID_ALIGNED_PTR(ptr, align) \
2526	( !((uintptr_t)(ptr) & (uintptr_t)((align) - 1)) \
2527	&& VALID_PTR(ptr) )
2528
2529
2530	/** @def VALID_PHYS32
2531	* 32 bits physical address validation macro.
2532	* @param Phys The RTGCPHYS address.
2533	*/
2534	#define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G )
2535
2536	/** @def N_
2537	* The \#define N_ is used to mark a string for translation. This is usable in
2538	* any part of the code, as it is only used by the tools that create message
2539	* catalogs. This macro is a no-op as far as the compiler and code generation
2540	* is concerned.
2541	*
2542	* If you want to both mark a string for translation and translate it, use _().
2543	*/
2544	#define N_(s) (s)
2545
2546	/** @def _
2547	* The \#define _ is used to mark a string for translation and to translate it
2548	* in one step.
2549	*
2550	* If you want to only mark a string for translation, use N_().
2551	*/
2552	#define _(s) gettext(s)
2553
2554
2555	/** @def __PRETTY_FUNCTION__
2556	* With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
2557	* for the other compilers.
2558	*/
2559	#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
2560	# ifdef _MSC_VER
2561	# define __PRETTY_FUNCTION__ __FUNCSIG__
2562	# else
2563	# define __PRETTY_FUNCTION__ __FUNCTION__
2564	# endif
2565	#endif
2566
2567
2568	/** @def RT_STRICT
2569	* The \#define RT_STRICT controls whether or not assertions and other runtime
2570	* checks should be compiled in or not. This is defined when DEBUG is defined.
2571	* If RT_NO_STRICT is defined, it will unconditionally be undefined.
2572	*
2573	* If you want assertions which are not subject to compile time options use
2574	* the AssertRelease*() flavors.
2575	*/
2576	#if !defined(RT_STRICT) && defined(DEBUG)
2577	# define RT_STRICT
2578	#endif
2579	#ifdef RT_NO_STRICT
2580	# undef RT_STRICT
2581	#endif
2582
2583	/** @todo remove this: */
2584	#if !defined(RT_LOCK_STRICT) && !defined(DEBUG_bird)
2585	# define RT_LOCK_NO_STRICT
2586	#endif
2587	#if !defined(RT_LOCK_STRICT_ORDER) && !defined(DEBUG_bird)
2588	# define RT_LOCK_NO_STRICT_ORDER
2589	#endif
2590
2591	/** @def RT_LOCK_STRICT
2592	* The \#define RT_LOCK_STRICT controls whether deadlock detection and related
2593	* checks are done in the lock and semaphore code. It is by default enabled in
2594	* RT_STRICT builds, but this behavior can be overridden by defining
2595	* RT_LOCK_NO_STRICT. */
2596	#if !defined(RT_LOCK_STRICT) && !defined(RT_LOCK_NO_STRICT) && defined(RT_STRICT)
2597	# define RT_LOCK_STRICT
2598	#endif
2599	/** @def RT_LOCK_NO_STRICT
2600	* The \#define RT_LOCK_NO_STRICT disables RT_LOCK_STRICT. */
2601	#if defined(RT_LOCK_NO_STRICT) && defined(RT_LOCK_STRICT)
2602	# undef RT_LOCK_STRICT
2603	#endif
2604
2605	/** @def RT_LOCK_STRICT_ORDER
2606	* The \#define RT_LOCK_STRICT_ORDER controls whether locking order is checked
2607	* by the lock and semaphore code. It is by default enabled in RT_STRICT
2608	* builds, but this behavior can be overridden by defining
2609	* RT_LOCK_NO_STRICT_ORDER. */
2610	#if !defined(RT_LOCK_STRICT_ORDER) && !defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_STRICT)
2611	# define RT_LOCK_STRICT_ORDER
2612	#endif
2613	/** @def RT_LOCK_NO_STRICT_ORDER
2614	* The \#define RT_LOCK_NO_STRICT_ORDER disables RT_LOCK_STRICT_ORDER. */
2615	#if defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_LOCK_STRICT_ORDER)
2616	# undef RT_LOCK_STRICT_ORDER
2617	#endif
2618
2619
2620	/** Source position. */
2621	#define RT_SRC_POS __FILE__, __LINE__, __PRETTY_FUNCTION__
2622
2623	/** Source position declaration. */
2624	#define RT_SRC_POS_DECL const char pszFile, unsigned iLine, const char pszFunction
2625
2626	/** Source position arguments. */
2627	#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
2628
2629	/** Applies NOREF() to the source position arguments. */
2630	#define RT_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
2631
2632
2633	/** @def RT_INLINE_ASM_EXTERNAL
2634	* Defined as 1 if the compiler does not support inline assembly.
2635	* The ASM* functions will then be implemented in external .asm files.
2636	*/
2637	#if (defined(_MSC_VER) && defined(RT_ARCH_AMD64)) \
2638	\|\| (!defined(RT_ARCH_AMD64) && !defined(RT_ARCH_X86))
2639	# define RT_INLINE_ASM_EXTERNAL 1
2640	#else
2641	# define RT_INLINE_ASM_EXTERNAL 0
2642	#endif
2643
2644	/** @def RT_INLINE_ASM_GNU_STYLE
2645	* Defined as 1 if the compiler understands GNU style inline assembly.
2646	*/
2647	#if defined(_MSC_VER)
2648	# define RT_INLINE_ASM_GNU_STYLE 0
2649	#else
2650	# define RT_INLINE_ASM_GNU_STYLE 1
2651	#endif
2652
2653	/** @def RT_INLINE_ASM_USES_INTRIN
2654	* Defined as the major MSC version if the compiler have and uses intrin.h.
2655	* Otherwise it is 0. */
2656	#ifdef _MSC_VER
2657	# if _MSC_VER >= 1700
2658	# define RT_INLINE_ASM_USES_INTRIN 17
2659	# elif _MSC_VER >= 1600
2660	# define RT_INLINE_ASM_USES_INTRIN 16
2661	# elif _MSC_VER >= 1500
2662	# define RT_INLINE_ASM_USES_INTRIN 15
2663	# elif _MSC_VER >= 1400
2664	# define RT_INLINE_ASM_USES_INTRIN 14
2665	# endif
2666	#endif
2667	#ifndef RT_INLINE_ASM_USES_INTRIN
2668	# define RT_INLINE_ASM_USES_INTRIN 0
2669	#endif
2670
2671	/** @} */
2672
2673
2674	/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
2675	* @ingroup grp_rt_cdefs
2676	* @{
2677	*/
2678
2679	#ifdef __cplusplus
2680
2681	/** @def DECLEXPORT_CLASS
2682	* How to declare an exported class. Place this macro after the 'class'
2683	* keyword in the declaration of every class you want to export.
2684	*
2685	* @note It is necessary to use this macro even for inner classes declared
2686	* inside the already exported classes. This is a GCC specific requirement,
2687	* but it seems not to harm other compilers.
2688	*/
2689	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
2690	# define DECLEXPORT_CLASS __declspec(dllexport)
2691	#elif defined(RT_USE_VISIBILITY_DEFAULT)
2692	# define DECLEXPORT_CLASS __attribute__((visibility("default")))
2693	#else
2694	# define DECLEXPORT_CLASS
2695	#endif
2696
2697	/** @def DECLIMPORT_CLASS
2698	* How to declare an imported class Place this macro after the 'class'
2699	* keyword in the declaration of every class you want to export.
2700	*
2701	* @note It is necessary to use this macro even for inner classes declared
2702	* inside the already exported classes. This is a GCC specific requirement,
2703	* but it seems not to harm other compilers.
2704	*/
2705	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
2706	# define DECLIMPORT_CLASS __declspec(dllimport)
2707	#elif defined(RT_USE_VISIBILITY_DEFAULT)
2708	# define DECLIMPORT_CLASS __attribute__((visibility("default")))
2709	#else
2710	# define DECLIMPORT_CLASS
2711	#endif
2712
2713	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
2714	* Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
2715	* resolver. The following snippet clearly demonstrates the code causing this
2716	* error:
2717	* @code
2718	* class A
2719	* {
2720	* public:
2721	* operator bool() const { return false; }
2722	* operator int*() const { return NULL; }
2723	* };
2724	* int main()
2725	* {
2726	* A a;
2727	* if (!a);
2728	* if (a && 0);
2729	* return 0;
2730	* }
2731	* @endcode
2732	* The code itself seems pretty valid to me and GCC thinks the same.
2733	*
2734	* This macro fixes the compiler error by explicitly overloading implicit
2735	* global operators !, && and \|\| that take the given class instance as one of
2736	* their arguments.
2737	*
2738	* The best is to use this macro right after the class declaration.
2739	*
2740	* @note The macro expands to nothing for compilers other than MSVC.
2741	*
2742	* @param Cls Class to apply the workaround to
2743	*/
2744	#if defined(_MSC_VER)
2745	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
2746	inline bool operator! (const Cls &that) { return !bool (that); } \
2747	inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
2748	inline bool operator\|\| (const Cls &that, bool b) { return bool (that) \|\| b; } \
2749	inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
2750	inline bool operator\|\| (bool b, const Cls &that) { return b \|\| bool (that); }
2751	#else
2752	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
2753	#endif
2754
2755	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
2756	* Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
2757	*
2758	* @param Tpl Name of the template class to apply the workaround to
2759	* @param ArgsDecl arguments of the template, as declared in \|<>\| after the
2760	* \|template\| keyword, including \|<>\|
2761	* @param Args arguments of the template, as specified in \|<>\| after the
2762	* template class name when using the, including \|<>\|
2763	*
2764	* Example:
2765	* @code
2766	* // template class declaration
2767	* template <class C>
2768	* class Foo { ... };
2769	* // applied workaround
2770	* WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
2771	* @endcode
2772	*/
2773	#if defined(_MSC_VER)
2774	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
2775	template ArgsDecl \
2776	inline bool operator! (const Tpl Args &that) { return !bool (that); } \
2777	template ArgsDecl \
2778	inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
2779	template ArgsDecl \
2780	inline bool operator\|\| (const Tpl Args &that, bool b) { return bool (that) \|\| b; } \
2781	template ArgsDecl \
2782	inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
2783	template ArgsDecl \
2784	inline bool operator\|\| (bool b, const Tpl Args &that) { return b \|\| bool (that); }
2785	#else
2786	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
2787	#endif
2788
2789
2790	/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
2791	* Declares the copy constructor and the assignment operation as inlined no-ops
2792	* (non-existent functions) for the given class. Use this macro inside the
2793	* private section if you want to effectively disable these operations for your
2794	* class.
2795	*
2796	* @param Cls class name to declare for
2797	*/
2798
2799	#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
2800	inline Cls (const Cls &); \
2801	inline Cls &operator= (const Cls &);
2802
2803
2804	/** @def DECLARE_CLS_NEW_DELETE_NOOP
2805	* Declares the new and delete operations as no-ops (non-existent functions)
2806	* for the given class. Use this macro inside the private section if you want
2807	* to effectively limit creating class instances on the stack only.
2808	*
2809	* @note The destructor of the given class must not be virtual, otherwise a
2810	* compile time error will occur. Note that this is not a drawback: having
2811	* the virtual destructor for a stack-based class is absolutely useless
2812	* (the real class of the stack-based instance is always known to the compiler
2813	* at compile time, so it will always call the correct destructor).
2814	*
2815	* @param Cls class name to declare for
2816	*/
2817	#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
2818	inline static void *operator new (size_t); \
2819	inline static void operator delete (void *);
2820
2821	#endif /* __cplusplus */
2822
2823	/** @} */
2824
2825	#endif
2826

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: