cdefs.h@ 57433

Last change on this file since 57433 was 57433, checked in by vboxsync, 9 years ago
cdefs.h: typo
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 94.4 KB

Line
1	/** @file
2	* IPRT - Common C and C++ definitions.
3	*/
4
5	/*
6	* Copyright (C) 2006-2015 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 targeting. 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_PROTO
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	* @remarks May not work on C++ methods, mainly intented for C-style APIs.
886	*
887	* @remarks The use of the nothrow attribute with GCC is because old compilers
888	* (4.1.1, 32-bit) leaking the nothrow into global space or something
889	* when used with RTDECL or similar. Using this forces use to have two
890	* macros, as the nothrow attribute is not for the function definition.
891	*/
892	#ifdef RT_EXCEPTIONS_ENABLED
893	# ifdef __GNUC__
894	# define RT_NO_THROW_PROTO __attribute__((__nothrow__))
895	# else
896	# define RT_NO_THROW_PROTO throw()
897	# endif
898	#else
899	# define RT_NO_THROW_PROTO
900	#endif
901
902	/** @def RT_NO_THROW_DEF
903	* The counter part to RT_NO_THROW_PROTO that is added to the function
904	* definition.
905	*/
906	#if defined(RT_EXCEPTIONS_ENABLED) && !defined(__GNUC__)
907	# define RT_NO_THROW_DEF RT_NO_THROW_PROTO
908	#else
909	# define RT_NO_THROW_DEF
910	#endif
911
912	/** @def RT_THROW
913	* How to express that a method or function throws a type of exceptions. Some
914	* compilers does not want this kind of information and will warning about it.
915	*
916	* @param type The type exception.
917	*
918	* @remarks If the actual throwing is done from the header, enclose it by
919	* \#ifdef RT_EXCEPTIONS_ENABLED ... \#else ... \#endif so the header
920	* compiles cleanly without exceptions enabled.
921	*
922	* Do NOT use this for the actual throwing of exceptions!
923	*/
924	#ifdef RT_EXCEPTIONS_ENABLED
925	# ifdef _MSC_VER
926	# if _MSC_VER >= 1310
927	# define RT_THROW(type)
928	# else
929	# define RT_THROW(type) throw(type)
930	# endif
931	# else
932	# define RT_THROW(type) throw(type)
933	# endif
934	#else
935	# define RT_THROW(type)
936	#endif
937
938	/** @def RT_IPRT_FORMAT_ATTR
939	* Identifies a function taking an IPRT format string.
940	* @param a_iFmt The index (1-based) of the format string argument.
941	* @param a_iArgs The index (1-based) of the first format argument, use 0 for
942	* va_list.
943	*/
944	#if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE)
945	# define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs) __attribute__((__iprt_format__(a_iFmt, a_iArgs)))
946	#else
947	# define RT_IPRT_FORMAT_ATTR(a_iFmt, a_iArgs)
948	#endif
949
950	/** @def RT_IPRT_FORMAT_ATTR_MAYBE_NULL
951	* Identifies a function taking an IPRT format string, NULL is allowed.
952	* @param a_iFmt The index (1-based) of the format string argument.
953	* @param a_iArgs The index (1-based) of the first format argument, use 0 for
954	* va_list.
955	*/
956	#if defined(__GNUC__) && defined(WITH_IPRT_FORMAT_ATTRIBUTE)
957	# define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs) __attribute__((__iprt_format_maybe_null__(a_iFmt, a_iArgs)))
958	#else
959	# define RT_IPRT_FORMAT_ATTR_MAYBE_NULL(a_iFmt, a_iArgs)
960	#endif
961
962
963	/** @def RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
964	* Indicates that the "hidden" visibility attribute can be used (GCC) */
965	#if defined(__GNUC__)
966	# if __GNUC__ >= 4 && !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS)
967	# define RT_GCC_SUPPORTS_VISIBILITY_HIDDEN
968	# endif
969	#endif
970
971	/** @def RTCALL
972	* The standard calling convention for the Runtime interfaces.
973	*
974	* @remarks The regparm(0) in the X86/GNUC variant deals with -mregparm=x use in
975	* the linux kernel and potentially elsewhere (3rd party).
976	*/
977	#ifdef _MSC_VER
978	# define RTCALL __cdecl
979	#elif defined(RT_OS_OS2)
980	# define RTCALL __cdecl
981	#elif defined(__GNUC__) && defined(RT_ARCH_X86)
982	# define RTCALL __attribute__((cdecl,regparm(0)))
983	#else
984	# define RTCALL
985	#endif
986
987	/** @def DECLEXPORT
988	* How to declare an exported function.
989	* @param type The return type of the function declaration.
990	*/
991	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
992	# define DECLEXPORT(type) __declspec(dllexport) type
993	#elif defined(RT_USE_VISIBILITY_DEFAULT)
994	# define DECLEXPORT(type) __attribute__((visibility("default"))) type
995	#else
996	# define DECLEXPORT(type) type
997	#endif
998
999	/** @def DECLIMPORT
1000	* How to declare an imported function.
1001	* @param type The return type of the function declaration.
1002	*/
1003	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
1004	# define DECLIMPORT(type) __declspec(dllimport) type
1005	#else
1006	# define DECLIMPORT(type) type
1007	#endif
1008
1009	/** @def DECLHIDDEN
1010	* How to declare a non-exported function or variable.
1011	* @param type The return type of the function or the data type of the variable.
1012	*/
1013	#if !defined(RT_GCC_SUPPORTS_VISIBILITY_HIDDEN) \|\| defined(RT_NO_VISIBILITY_HIDDEN)
1014	# define DECLHIDDEN(type) type
1015	#else
1016	# define DECLHIDDEN(type) __attribute__((visibility("hidden"))) type
1017	#endif
1018
1019	/** @def DECL_HIDDEN_CONST
1020	* Workaround for g++ warnings when applying the hidden attribute to a const
1021	* definition. Use DECLHIDDEN for the declaration.
1022	* @param a_Type The return type of the function or the data type of
1023	* the variable.
1024	*/
1025	#if defined(__cplusplus) && defined(__GNUC__)
1026	# define DECL_HIDDEN_CONST(a_Type) a_Type
1027	#else
1028	# define DECL_HIDDEN_CONST(a_Type) DECLHIDDEN(a_Type)
1029	#endif
1030
1031	/** @def DECL_INVALID
1032	* How to declare a function not available for linking in the current context.
1033	* The purpose is to create compile or like time errors when used. This isn't
1034	* possible on all platforms.
1035	* @param type The return type of the function.
1036	*/
1037	#if defined(_MSC_VER)
1038	# define DECL_INVALID(type) __declspec(dllimport) type __stdcall
1039	#elif defined(__GNUC__) && defined(__cplusplus)
1040	# define DECL_INVALID(type) extern "C++" type
1041	#else
1042	# define DECL_INVALID(type) type
1043	#endif
1044
1045	/** @def DECLASM
1046	* How to declare an internal assembly function.
1047	* @param type The return type of the function declaration.
1048	*/
1049	#ifdef __cplusplus
1050	# define DECLASM(type) extern "C" type RTCALL
1051	#else
1052	# define DECLASM(type) type RTCALL
1053	#endif
1054
1055	/** @def DECLASMTYPE
1056	* How to declare an internal assembly function type.
1057	* @param type The return type of the function.
1058	*/
1059	#define DECLASMTYPE(type) type RTCALL
1060
1061	/** @def DECLNORETURN
1062	* How to declare a function which does not return.
1063	* @note: This macro can be combined with other macros, for example
1064	* @code
1065	* EMR3DECL(DECLNORETURN(void)) foo(void);
1066	* @endcode
1067	*/
1068	#ifdef _MSC_VER
1069	# define DECLNORETURN(type) __declspec(noreturn) type
1070	#elif defined(__GNUC__)
1071	# define DECLNORETURN(type) __attribute__((noreturn)) type
1072	#else
1073	# define DECLNORETURN(type) type
1074	#endif
1075
1076	/** @def DECLWEAK
1077	* How to declare a variable which is not necessarily resolved at
1078	* runtime.
1079	* @note: This macro can be combined with other macros, for example
1080	* @code
1081	* EMR3DECL(DECLWEAK(int)) foo;
1082	* @endcode
1083	*/
1084	#if defined(__GNUC__)
1085	# define DECLWEAK(type) type __attribute__((weak))
1086	#else
1087	# define DECLWEAK(type) type
1088	#endif
1089
1090	/** @def DECLCALLBACK
1091	* How to declare an call back function type.
1092	* @param type The return type of the function declaration.
1093	*/
1094	#define DECLCALLBACK(type) type RTCALL
1095
1096	/** @def DECLCALLBACKPTR
1097	* How to declare an call back function pointer.
1098	* @param type The return type of the function declaration.
1099	* @param name The name of the variable member.
1100	*/
1101	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
1102	# define DECLCALLBACKPTR(type, name) type (* RTCALL name)
1103	#else
1104	# define DECLCALLBACKPTR(type, name) type (RTCALL * name)
1105	#endif
1106
1107	/** @def DECLCALLBACKMEMBER
1108	* How to declare an call back function pointer member.
1109	* @param type The return type of the function declaration.
1110	* @param name The name of the struct/union/class member.
1111	*/
1112	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
1113	# define DECLCALLBACKMEMBER(type, name) type (* RTCALL name)
1114	#else
1115	# define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
1116	#endif
1117
1118	/** @def DECLR3CALLBACKMEMBER
1119	* How to declare an call back function pointer member - R3 Ptr.
1120	* @param type The return type of the function declaration.
1121	* @param name The name of the struct/union/class member.
1122	* @param args The argument list enclosed in parentheses.
1123	*/
1124	#ifdef IN_RING3
1125	# define DECLR3CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1126	#else
1127	# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
1128	#endif
1129
1130	/** @def DECLRCCALLBACKMEMBER
1131	* How to declare an call back function pointer member - RC Ptr.
1132	* @param type The return type of the function declaration.
1133	* @param name The name of the struct/union/class member.
1134	* @param args The argument list enclosed in parentheses.
1135	*/
1136	#ifdef IN_RC
1137	# define DECLRCCALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1138	#else
1139	# define DECLRCCALLBACKMEMBER(type, name, args) RTRCPTR name
1140	#endif
1141
1142	/** @def DECLR0CALLBACKMEMBER
1143	* How to declare an call back function pointer member - R0 Ptr.
1144	* @param type The return type of the function declaration.
1145	* @param name The name of the struct/union/class member.
1146	* @param args The argument list enclosed in parentheses.
1147	*/
1148	#ifdef IN_RING0
1149	# define DECLR0CALLBACKMEMBER(type, name, args) DECLCALLBACKMEMBER(type, name) args
1150	#else
1151	# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
1152	#endif
1153
1154	/** @def DECLINLINE
1155	* How to declare a function as inline.
1156	* @param type The return type of the function declaration.
1157	* @remarks Don't use this macro on C++ methods.
1158	*/
1159	#ifdef __GNUC__
1160	# define DECLINLINE(type) static __inline__ type
1161	#elif defined(__cplusplus)
1162	# define DECLINLINE(type) inline type
1163	#elif defined(_MSC_VER)
1164	# define DECLINLINE(type) _inline type
1165	#elif defined(__IBMC__)
1166	# define DECLINLINE(type) _Inline type
1167	#else
1168	# define DECLINLINE(type) inline type
1169	#endif
1170
1171
1172	/** @def DECL_FORCE_INLINE
1173	* How to declare a function as inline and try convince the compiler to always
1174	* inline it regardless of optimization switches.
1175	* @param type The return type of the function declaration.
1176	* @remarks Use sparsely and with care. Don't use this macro on C++ methods.
1177	*/
1178	#ifdef __GNUC__
1179	# define DECL_FORCE_INLINE(type) __attribute__((__always_inline__)) DECLINLINE(type)
1180	#elif defined(_MSC_VER)
1181	# define DECL_FORCE_INLINE(type) __forceinline type
1182	#else
1183	# define DECL_FORCE_INLINE(type) DECLINLINE(type)
1184	#endif
1185
1186
1187	/** @def DECL_NO_INLINE
1188	* How to declare a function telling the compiler not to inline it.
1189	* @param scope The function scope, static or RT_NOTHING.
1190	* @param type The return type of the function declaration.
1191	* @remarks Don't use this macro on C++ methods.
1192	*/
1193	#ifdef __GNUC__
1194	# define DECL_NO_INLINE(scope,type) __attribute__((__noinline__)) scope type
1195	#elif defined(_MSC_VER)
1196	# define DECL_NO_INLINE(scope,type) __declspec(noinline) scope type
1197	#else
1198	# define DECL_NO_INLINE(scope,type) scope type
1199	#endif
1200
1201
1202	/** @def IN_RT_STATIC
1203	* Used to indicate whether we're linking against a static IPRT
1204	* or not. The IPRT symbols will be declared as hidden (if
1205	* supported). Note that this define has no effect without setting
1206	* IN_RT_R0, IN_RT_R3 or IN_RT_RC indicators are set first.
1207	*/
1208
1209	/** @def IN_RT_R0
1210	* Used to indicate whether we're inside the same link module as
1211	* the HC Ring-0 Runtime Library.
1212	*/
1213	/** @def RTR0DECL(type)
1214	* Runtime Library HC Ring-0 export or import declaration.
1215	* @param type The return type of the function declaration.
1216	*/
1217	#ifdef IN_RT_R0
1218	# ifdef IN_RT_STATIC
1219	# define RTR0DECL(type) DECLHIDDEN(type) RTCALL
1220	# else
1221	# define RTR0DECL(type) DECLEXPORT(type) RTCALL
1222	# endif
1223	#else
1224	# define RTR0DECL(type) DECLIMPORT(type) RTCALL
1225	#endif
1226
1227	/** @def IN_RT_R3
1228	* Used to indicate whether we're inside the same link module as
1229	* the HC Ring-3 Runtime Library.
1230	*/
1231	/** @def RTR3DECL(type)
1232	* Runtime Library HC Ring-3 export or import declaration.
1233	* @param type The return type of the function declaration.
1234	*/
1235	#ifdef IN_RT_R3
1236	# ifdef IN_RT_STATIC
1237	# define RTR3DECL(type) DECLHIDDEN(type) RTCALL
1238	# else
1239	# define RTR3DECL(type) DECLEXPORT(type) RTCALL
1240	# endif
1241	#else
1242	# define RTR3DECL(type) DECLIMPORT(type) RTCALL
1243	#endif
1244
1245	/** @def IN_RT_RC
1246	* Used to indicate whether we're inside the same link module as the raw-mode
1247	* context (RC) runtime library.
1248	*/
1249	/** @def RTRCDECL(type)
1250	* Runtime Library raw-mode context export or import declaration.
1251	* @param type The return type of the function declaration.
1252	*/
1253	#ifdef IN_RT_RC
1254	# ifdef IN_RT_STATIC
1255	# define RTRCDECL(type) DECLHIDDEN(type) RTCALL
1256	# else
1257	# define RTRCDECL(type) DECLEXPORT(type) RTCALL
1258	# endif
1259	#else
1260	# define RTRCDECL(type) DECLIMPORT(type) RTCALL
1261	#endif
1262
1263	/** @def RTDECL(type)
1264	* Runtime Library export or import declaration.
1265	* Functions declared using this macro exists in all contexts.
1266	* @param type The return type of the function declaration.
1267	*/
1268	#if defined(IN_RT_R3) \|\| defined(IN_RT_RC) \|\| defined(IN_RT_R0)
1269	# ifdef IN_RT_STATIC
1270	# define RTDECL(type) DECLHIDDEN(type) RTCALL
1271	# else
1272	# define RTDECL(type) DECLEXPORT(type) RTCALL
1273	# endif
1274	#else
1275	# define RTDECL(type) DECLIMPORT(type) RTCALL
1276	#endif
1277
1278	/** @def RTDATADECL(type)
1279	* Runtime Library export or import declaration.
1280	* Data declared using this macro exists in all contexts.
1281	* @param type The data type.
1282	*/
1283	/** @def RT_DECL_DATA_CONST(type)
1284	* Definition of a const variable. See DECL_HIDDEN_CONST.
1285	* @param type The const data type.
1286	*/
1287	#if defined(IN_RT_R3) \|\| defined(IN_RT_RC) \|\| defined(IN_RT_R0)
1288	# ifdef IN_RT_STATIC
1289	# define RTDATADECL(type) DECLHIDDEN(type)
1290	# define RT_DECL_DATA_CONST(type) DECL_HIDDEN_CONST(type)
1291	# else
1292	# define RTDATADECL(type) DECLEXPORT(type)
1293	# if defined(__cplusplus) && defined(__GNUC__)
1294	# define RT_DECL_DATA_CONST(type) type
1295	# else
1296	# define RT_DECL_DATA_CONST(type) DECLEXPORT(type)
1297	# endif
1298	# endif
1299	#else
1300	# define RTDATADECL(type) DECLIMPORT(type)
1301	# define RT_DECL_DATA_CONST(type) DECLIMPORT(type)
1302	#endif
1303
1304	/** @def RT_DECL_CLASS
1305	* Declares an class living in the runtime.
1306	*/
1307	#if defined(IN_RT_R3) \|\| defined(IN_RT_RC) \|\| defined(IN_RT_R0)
1308	# ifdef IN_RT_STATIC
1309	# define RT_DECL_CLASS
1310	# else
1311	# define RT_DECL_CLASS DECLEXPORT_CLASS
1312	# endif
1313	#else
1314	# define RT_DECL_CLASS DECLIMPORT_CLASS
1315	#endif
1316
1317
1318	/** @def RT_NOCRT
1319	* Symbol name wrapper for the No-CRT bits.
1320	*
1321	* In order to coexist in the same process as other CRTs, we need to
1322	* decorate the symbols such that they don't conflict the ones in the
1323	* other CRTs. The result of such conflicts / duplicate symbols can
1324	* confuse the dynamic loader on Unix like systems.
1325	*
1326	* Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
1327	* Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
1328	* wrapped names.
1329	*/
1330	/** @def RT_NOCRT_STR
1331	* Same as RT_NOCRT only it'll return a double quoted string of the result.
1332	*/
1333	#ifndef RT_WITHOUT_NOCRT_WRAPPERS
1334	# define RT_NOCRT(name) nocrt_ ## name
1335	# define RT_NOCRT_STR(name) "nocrt_" # name
1336	#else
1337	# define RT_NOCRT(name) name
1338	# define RT_NOCRT_STR(name) #name
1339	#endif
1340
1341
1342
1343	/** @def RT_LIKELY
1344	* Give the compiler a hint that an expression is very likely to hold true.
1345	*
1346	* Some compilers support explicit branch prediction so that the CPU backend
1347	* can hint the processor and also so that code blocks can be reordered such
1348	* that the predicted path sees a more linear flow, thus improving cache
1349	* behaviour, etc.
1350	*
1351	* IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
1352	* this compiler feature when present.
1353	*
1354	* A few notes about the usage:
1355	*
1356	* - Generally, order your code use RT_LIKELY() instead of RT_UNLIKELY().
1357	*
1358	* - Generally, use RT_UNLIKELY() with error condition checks (unless you
1359	* have some _strong_ reason to do otherwise, in which case document it),
1360	* and/or RT_LIKELY() with success condition checks, assuming you want
1361	* to optimize for the success path.
1362	*
1363	* - Other than that, if you don't know the likelihood of a test succeeding
1364	* from empirical or other 'hard' evidence, don't make predictions unless
1365	* you happen to be a Dirk Gently character.
1366	*
1367	* - These macros are meant to be used in places that get executed a lot. It
1368	* is wasteful to make predictions in code that is executed rarely (e.g.
1369	* at subsystem initialization time) as the basic block reordering that this
1370	* affects can often generate larger code.
1371	*
1372	* - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
1373	* and RT_UNLIKELY(). Should you wish for prediction free status checks,
1374	* use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
1375	*
1376	*
1377	* @returns the boolean result of the expression.
1378	* @param expr The expression that's very likely to be true.
1379	* @see RT_UNLIKELY
1380	*/
1381	/** @def RT_UNLIKELY
1382	* Give the compiler a hint that an expression is highly unlikely to hold true.
1383	*
1384	* See the usage instructions give in the RT_LIKELY() docs.
1385	*
1386	* @returns the boolean result of the expression.
1387	* @param expr The expression that's very unlikely to be true.
1388	* @see RT_LIKELY
1389	*
1390	* @deprecated Please use RT_LIKELY() instead wherever possible! That gives us
1391	* a better chance of the windows compilers to generate favorable code
1392	* too. The belief is that the compiler will by default assume the
1393	* if-case is more likely than the else-case.
1394	*/
1395	#if defined(__GNUC__)
1396	# if __GNUC__ >= 3 && !defined(FORTIFY_RUNNING)
1397	# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
1398	# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
1399	# else
1400	# define RT_LIKELY(expr) (expr)
1401	# define RT_UNLIKELY(expr) (expr)
1402	# endif
1403	#else
1404	# define RT_LIKELY(expr) (expr)
1405	# define RT_UNLIKELY(expr) (expr)
1406	#endif
1407
1408
1409	/** @def RT_STR
1410	* Returns the argument as a string constant.
1411	* @param str Argument to stringify. */
1412	#define RT_STR(str) #str
1413	/** @def RT_XSTR
1414	* Returns the expanded argument as a string.
1415	* @param str Argument to expand and stringy. */
1416	#define RT_XSTR(str) RT_STR(str)
1417
1418	/** @def RT_CONCAT
1419	* Concatenate the expanded arguments without any extra spaces in between.
1420	*
1421	* @param a The first part.
1422	* @param b The second part.
1423	*/
1424	#define RT_CONCAT(a,b) RT_CONCAT_HLP(a,b)
1425	/** RT_CONCAT helper, don't use. */
1426	#define RT_CONCAT_HLP(a,b) a##b
1427
1428	/** @def RT_CONCAT
1429	* Concatenate the expanded arguments without any extra spaces in between.
1430	*
1431	* @param a The 1st part.
1432	* @param b The 2nd part.
1433	* @param c The 3rd part.
1434	*/
1435	#define RT_CONCAT3(a,b,c) RT_CONCAT3_HLP(a,b,c)
1436	/** RT_CONCAT3 helper, don't use. */
1437	#define RT_CONCAT3_HLP(a,b,c) a##b##c
1438
1439	/** @def RT_CONCAT
1440	* Concatenate the expanded arguments without any extra spaces in between.
1441	*
1442	* @param a The 1st part.
1443	* @param b The 2nd part.
1444	* @param c The 3rd part.
1445	*/
1446	#define RT_CONCAT4(a,b,c,d) RT_CONCAT4_HLP(a,b,c,d)
1447	/** RT_CONCAT4 helper, don't use. */
1448	#define RT_CONCAT4_HLP(a,b,c,d) a##b##c##d
1449
1450	/**
1451	* String constant tuple - string constant, strlen(string constant).
1452	*
1453	* @param a_szConst String constant.
1454	*/
1455	#define RT_STR_TUPLE(a_szConst) a_szConst, (sizeof(a_szConst) - 1)
1456
1457
1458	/**
1459	* Macro for using in switch statements that turns constants into strings.
1460	*
1461	* @param a_Const The constant (not string).
1462	*/
1463	#define RT_CASE_RET_STR(a_Const) case a_Const: return #a_Const
1464
1465
1466	/** @def RT_BIT
1467	* Convert a bit number into an integer bitmask (unsigned).
1468	* @param bit The bit number.
1469	*/
1470	#define RT_BIT(bit) ( 1U << (bit) )
1471
1472	/** @def RT_BIT_32
1473	* Convert a bit number into a 32-bit bitmask (unsigned).
1474	* @param bit The bit number.
1475	*/
1476	#define RT_BIT_32(bit) ( UINT32_C(1) << (bit) )
1477
1478	/** @def RT_BIT_64
1479	* Convert a bit number into a 64-bit bitmask (unsigned).
1480	* @param bit The bit number.
1481	*/
1482	#define RT_BIT_64(bit) ( UINT64_C(1) << (bit) )
1483
1484	/** @def RT_ALIGN
1485	* Align macro.
1486	* @param u Value to align.
1487	* @param uAlignment The alignment. Power of two!
1488	*
1489	* @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
1490	* When possible use any of the other RT_ALIGN_* macros. And when that's not
1491	* possible, make 101% sure that uAlignment is specified with a right sized type.
1492	*
1493	* Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
1494	* you a 32-bit return value!
1495	*
1496	* In short: Don't use this macro. Use RT_ALIGN_T() instead.
1497	*/
1498	#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
1499
1500	/** @def RT_ALIGN_T
1501	* Align macro.
1502	* @param u Value to align.
1503	* @param uAlignment The alignment. Power of two!
1504	* @param type Integer type to use while aligning.
1505	* @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
1506	*/
1507	#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
1508
1509	/** @def RT_ALIGN_32
1510	* Align macro for a 32-bit value.
1511	* @param u32 Value to align.
1512	* @param uAlignment The alignment. Power of two!
1513	*/
1514	#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
1515
1516	/** @def RT_ALIGN_64
1517	* Align macro for a 64-bit value.
1518	* @param u64 Value to align.
1519	* @param uAlignment The alignment. Power of two!
1520	*/
1521	#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
1522
1523	/** @def RT_ALIGN_Z
1524	* Align macro for size_t.
1525	* @param cb Value to align.
1526	* @param uAlignment The alignment. Power of two!
1527	*/
1528	#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
1529
1530	/** @def RT_ALIGN_P
1531	* Align macro for pointers.
1532	* @param pv Value to align.
1533	* @param uAlignment The alignment. Power of two!
1534	*/
1535	#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
1536
1537	/** @def RT_ALIGN_PT
1538	* Align macro for pointers with type cast.
1539	* @param u Value to align.
1540	* @param uAlignment The alignment. Power of two!
1541	* @param CastType The type to cast the result to.
1542	*/
1543	#define RT_ALIGN_PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, uintptr_t) )
1544
1545	/** @def RT_ALIGN_R3PT
1546	* Align macro for ring-3 pointers with type cast.
1547	* @param u Value to align.
1548	* @param uAlignment The alignment. Power of two!
1549	* @param CastType The type to cast the result to.
1550	*/
1551	#define RT_ALIGN_R3PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR) )
1552
1553	/** @def RT_ALIGN_R0PT
1554	* Align macro for ring-0 pointers with type cast.
1555	* @param u Value to align.
1556	* @param uAlignment The alignment. Power of two!
1557	* @param CastType The type to cast the result to.
1558	*/
1559	#define RT_ALIGN_R0PT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR) )
1560
1561	/** @def RT_ALIGN_GCPT
1562	* Align macro for GC pointers with type cast.
1563	* @param u Value to align.
1564	* @param uAlignment The alignment. Power of two!
1565	* @param CastType The type to cast the result to.
1566	*/
1567	#define RT_ALIGN_GCPT(u, uAlignment, CastType) ( (CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR) )
1568
1569
1570	/** @def RT_OFFSETOF
1571	* Our own special offsetof() variant, returns a signed result.
1572	*
1573	* This differs from the usual offsetof() in that it's not relying on builtin
1574	* compiler stuff and thus can use variables in arrays the structure may
1575	* contain. This is useful to determine the sizes of structures ending
1576	* with a variable length field. For gcc >= 4.4 see @bugref{7775}.
1577	*
1578	* @returns offset into the structure of the specified member. signed.
1579	* @param type Structure type.
1580	* @param member Member.
1581	*/
1582	#if defined(__GNUC__) && defined(__cplusplus) && (__GNUC__ > 4 \|\| (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1583	# define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type )(void )0x1000)->member) - 0x1000 )
1584	#else
1585	# define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type )(void )0)->member) )
1586	#endif
1587
1588	/** @def RT_UOFFSETOF
1589	* Our own special offsetof() variant, returns an unsigned result.
1590	*
1591	* This differs from the usual offsetof() in that it's not relying on builtin
1592	* compiler stuff and thus can use variables in arrays the structure may
1593	* contain. This is useful to determine the sizes of structures ending
1594	* with a variable length field. For gcc >= 4.4 see @bugref{7775}.
1595	*
1596	* @returns offset into the structure of the specified member. unsigned.
1597	* @param type Structure type.
1598	* @param member Member.
1599	*/
1600	#if defined(__GNUC__) && defined(__cplusplus) && (__GNUC__ > 4 \|\| (__GNUC__ == 4 && __GNUC_MINOR__ >= 4))
1601	# define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type )(void )0x1000)->member) - 0x1000 )
1602	#else
1603	# define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type )(void )0)->member) )
1604	#endif
1605
1606	/** @def RT_OFFSETOF_ADD
1607	* RT_OFFSETOF with an addend.
1608	*
1609	* @returns offset into the structure of the specified member. signed.
1610	* @param type Structure type.
1611	* @param member Member.
1612	* @param addend The addend to add to the offset.
1613	*/
1614	#define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) )
1615
1616	/** @def RT_UOFFSETOF_ADD
1617	* RT_UOFFSETOF with an addend.
1618	*
1619	* @returns offset into the structure of the specified member. signed.
1620	* @param type Structure type.
1621	* @param member Member.
1622	* @param addend The addend to add to the offset.
1623	*/
1624	#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type )(void )(uintptr_t)(addend))->member) )
1625
1626	/** @def RT_SIZEOFMEMB
1627	* Get the size of a structure member.
1628	*
1629	* @returns size of the structure member.
1630	* @param type Structure type.
1631	* @param member Member.
1632	*/
1633	#define RT_SIZEOFMEMB(type, member) ( sizeof(((type )(void )0)->member) )
1634
1635	/** @def RT_FROM_MEMBER
1636	* Convert a pointer to a structure member into a pointer to the structure.
1637	*
1638	* @returns pointer to the structure.
1639	* @param pMem Pointer to the member.
1640	* @param Type Structure type.
1641	* @param Member Member name.
1642	*/
1643	#define RT_FROM_MEMBER(pMem, Type, Member) ( (Type ) ((uint8_t )(void *)(pMem) - RT_UOFFSETOF(Type, Member)) )
1644
1645	/** @def RT_FROM_CPP_MEMBER
1646	* Same as RT_FROM_MEMBER except it avoids the annoying g++ warnings about
1647	* invalid access to non-static data member of NULL object.
1648	*
1649	* @returns pointer to the structure.
1650	* @param pMem Pointer to the member.
1651	* @param Type Structure type.
1652	* @param Member Member name.
1653	*
1654	* @remarks Using the __builtin_offsetof does not shut up the compiler.
1655	*/
1656	#if defined(__GNUC__) && defined(__cplusplus)
1657	# define RT_FROM_CPP_MEMBER(pMem, Type, Member) \
1658	( (Type ) ((uintptr_t)(pMem) - (uintptr_t)&((Type )0x1000)->Member + 0x1000U) )
1659	#else
1660	# define RT_FROM_CPP_MEMBER(pMem, Type, Member) RT_FROM_MEMBER(pMem, Type, Member)
1661	#endif
1662
1663	/** @def RT_ELEMENTS
1664	* Calculates the number of elements in a statically sized array.
1665	* @returns Element count.
1666	* @param aArray Array in question.
1667	*/
1668	#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
1669
1670	/**
1671	* Checks if the value is a power of two.
1672	*
1673	* @returns true if power of two, false if not.
1674	* @param uVal The value to test.
1675	* @remarks 0 is a power of two.
1676	* @see VERR_NOT_POWER_OF_TWO
1677	*/
1678	#define RT_IS_POWER_OF_TWO(uVal) ( ((uVal) & ((uVal) - 1)) == 0)
1679
1680	#ifdef RT_OS_OS2
1681	/* Undefine RT_MAX since there is an unfortunate clash with the max
1682	resource type define in os2.h. */
1683	# undef RT_MAX
1684	#endif
1685
1686	/** @def RT_MAX
1687	* Finds the maximum value.
1688	* @returns The higher of the two.
1689	* @param Value1 Value 1
1690	* @param Value2 Value 2
1691	*/
1692	#define RT_MAX(Value1, Value2) ( (Value1) >= (Value2) ? (Value1) : (Value2) )
1693
1694	/** @def RT_MIN
1695	* Finds the minimum value.
1696	* @returns The lower of the two.
1697	* @param Value1 Value 1
1698	* @param Value2 Value 2
1699	*/
1700	#define RT_MIN(Value1, Value2) ( (Value1) <= (Value2) ? (Value1) : (Value2) )
1701
1702	/** @def RT_CLAMP
1703	* Clamps the value to minimum and maximum values.
1704	* @returns The clamped value.
1705	* @param Value The value to check.
1706	* @param Min Minimum value.
1707	* @param Max Maximum value.
1708	*/
1709	#define RT_CLAMP(Value, Min, Max) ( (Value) > (Max) ? (Max) : (Value) < (Min) ? (Min) : (Value) )
1710
1711	/** @def RT_ABS
1712	* Get the absolute (non-negative) value.
1713	* @returns The absolute value of Value.
1714	* @param Value The value.
1715	*/
1716	#define RT_ABS(Value) ( (Value) >= 0 ? (Value) : -(Value) )
1717
1718	/** @def RT_BOOL
1719	* Turn non-zero/zero into true/false
1720	* @returns The resulting boolean value.
1721	* @param Value The value.
1722	*/
1723	#define RT_BOOL(Value) ( !!(Value) )
1724
1725	/** @def RT_LO_U8
1726	* Gets the low uint8_t of a uint16_t or something equivalent. */
1727	#ifdef __GNUC__
1728	# define RT_LO_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)(a); })
1729	#else
1730	# define RT_LO_U8(a) ( (uint8_t)(a) )
1731	#endif
1732	/** @def RT_HI_U8
1733	* Gets the high uint8_t of a uint16_t or something equivalent. */
1734	#ifdef __GNUC__
1735	# define RT_HI_U8(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint16_t)); (uint8_t)((a) >> 8); })
1736	#else
1737	# define RT_HI_U8(a) ( (uint8_t)((a) >> 8) )
1738	#endif
1739
1740	/** @def RT_LO_U16
1741	* Gets the low uint16_t of a uint32_t or something equivalent. */
1742	#ifdef __GNUC__
1743	# define RT_LO_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)(a); })
1744	#else
1745	# define RT_LO_U16(a) ( (uint16_t)(a) )
1746	#endif
1747	/** @def RT_HI_U16
1748	* Gets the high uint16_t of a uint32_t or something equivalent. */
1749	#ifdef __GNUC__
1750	# define RT_HI_U16(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint32_t)); (uint16_t)((a) >> 16); })
1751	#else
1752	# define RT_HI_U16(a) ( (uint16_t)((a) >> 16) )
1753	#endif
1754
1755	/** @def RT_LO_U32
1756	* Gets the low uint32_t of a uint64_t or something equivalent. */
1757	#ifdef __GNUC__
1758	# define RT_LO_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)(a); })
1759	#else
1760	# define RT_LO_U32(a) ( (uint32_t)(a) )
1761	#endif
1762	/** @def RT_HI_U32
1763	* Gets the high uint32_t of a uint64_t or something equivalent. */
1764	#ifdef __GNUC__
1765	# define RT_HI_U32(a) __extension__ ({ AssertCompile(sizeof((a)) == sizeof(uint64_t)); (uint32_t)((a) >> 32); })
1766	#else
1767	# define RT_HI_U32(a) ( (uint32_t)((a) >> 32) )
1768	#endif
1769
1770	/** @def RT_BYTE1
1771	* Gets the first byte of something. */
1772	#define RT_BYTE1(a) ( (a) & 0xff )
1773	/** @def RT_BYTE2
1774	* Gets the second byte of something. */
1775	#define RT_BYTE2(a) ( ((a) >> 8) & 0xff )
1776	/** @def RT_BYTE3
1777	* Gets the second byte of something. */
1778	#define RT_BYTE3(a) ( ((a) >> 16) & 0xff )
1779	/** @def RT_BYTE4
1780	* Gets the fourth byte of something. */
1781	#define RT_BYTE4(a) ( ((a) >> 24) & 0xff )
1782	/** @def RT_BYTE5
1783	* Gets the fifth byte of something. */
1784	#define RT_BYTE5(a) ( ((a) >> 32) & 0xff )
1785	/** @def RT_BYTE6
1786	* Gets the sixth byte of something. */
1787	#define RT_BYTE6(a) ( ((a) >> 40) & 0xff )
1788	/** @def RT_BYTE7
1789	* Gets the seventh byte of something. */
1790	#define RT_BYTE7(a) ( ((a) >> 48) & 0xff )
1791	/** @def RT_BYTE8
1792	* Gets the eight byte of something. */
1793	#define RT_BYTE8(a) ( ((a) >> 56) & 0xff )
1794
1795
1796	/** @def RT_LODWORD
1797	* Gets the low dword (=uint32_t) of something.
1798	* @deprecated Use RT_LO_U32. */
1799	#define RT_LODWORD(a) ( (uint32_t)(a) )
1800	/** @def RT_HIDWORD
1801	* Gets the high dword (=uint32_t) of a 64-bit of something.
1802	* @deprecated Use RT_HI_U32. */
1803	#define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) )
1804
1805	/** @def RT_LOWORD
1806	* Gets the low word (=uint16_t) of something.
1807	* @deprecated Use RT_LO_U16. */
1808	#define RT_LOWORD(a) ( (a) & 0xffff )
1809	/** @def RT_HIWORD
1810	* Gets the high word (=uint16_t) of a 32-bit something.
1811	* @deprecated Use RT_HI_U16. */
1812	#define RT_HIWORD(a) ( (a) >> 16 )
1813
1814	/** @def RT_LOBYTE
1815	* Gets the low byte of something.
1816	* @deprecated Use RT_LO_U8. */
1817	#define RT_LOBYTE(a) ( (a) & 0xff )
1818	/** @def RT_HIBYTE
1819	* Gets the high byte of a 16-bit something.
1820	* @deprecated Use RT_HI_U8. */
1821	#define RT_HIBYTE(a) ( (a) >> 8 )
1822
1823
1824	/** @def RT_MAKE_U64
1825	* Constructs a uint64_t value from two uint32_t values.
1826	*/
1827	#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 \| (uint32_t)(Lo) )
1828
1829	/** @def RT_MAKE_U64_FROM_U16
1830	* Constructs a uint64_t value from four uint16_t values.
1831	*/
1832	#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
1833	((uint64_t)( (uint64_t)((uint16_t)(w3)) << 48 \
1834	\| (uint64_t)((uint16_t)(w2)) << 32 \
1835	\| (uint32_t)((uint16_t)(w1)) << 16 \
1836	\| (uint16_t)(w0) ))
1837
1838	/** @def RT_MAKE_U64_FROM_U8
1839	* Constructs a uint64_t value from eight uint8_t values.
1840	*/
1841	#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
1842	((uint64_t)( (uint64_t)((uint8_t)(b7)) << 56 \
1843	\| (uint64_t)((uint8_t)(b6)) << 48 \
1844	\| (uint64_t)((uint8_t)(b5)) << 40 \
1845	\| (uint64_t)((uint8_t)(b4)) << 32 \
1846	\| (uint32_t)((uint8_t)(b3)) << 24 \
1847	\| (uint32_t)((uint8_t)(b2)) << 16 \
1848	\| (uint16_t)((uint8_t)(b1)) << 8 \
1849	\| (uint8_t)(b0) ))
1850
1851	/** @def RT_MAKE_U32
1852	* Constructs a uint32_t value from two uint16_t values.
1853	*/
1854	#define RT_MAKE_U32(Lo, Hi) \
1855	((uint32_t)( (uint32_t)((uint16_t)(Hi)) << 16 \
1856	\| (uint16_t)(Lo) ))
1857
1858	/** @def RT_MAKE_U32_FROM_U8
1859	* Constructs a uint32_t value from four uint8_t values.
1860	*/
1861	#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
1862	((uint32_t)( (uint32_t)((uint8_t)(b3)) << 24 \
1863	\| (uint32_t)((uint8_t)(b2)) << 16 \
1864	\| (uint16_t)((uint8_t)(b1)) << 8 \
1865	\| (uint8_t)(b0) ))
1866
1867	/** @def RT_MAKE_U16
1868	* Constructs a uint16_t value from two uint8_t values.
1869	*/
1870	#define RT_MAKE_U16(Lo, Hi) \
1871	((uint16_t)( (uint16_t)((uint8_t)(Hi)) << 8 \
1872	\| (uint8_t)(Lo) ))
1873
1874
1875	/** @def RT_BSWAP_U64
1876	* Reverses the byte order of an uint64_t value. */
1877	#if 0
1878	# define RT_BSWAP_U64(u64) RT_BSWAP_U64_C(u64)
1879	#elif defined(__GNUC__)
1880	# define RT_BSWAP_U64(u64) (__builtin_constant_p((u64)) \
1881	? RT_BSWAP_U64_C(u64) : ASMByteSwapU64(u64))
1882	#else
1883	# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
1884	#endif
1885
1886	/** @def RT_BSWAP_U32
1887	* Reverses the byte order of an uint32_t value. */
1888	#if 0
1889	# define RT_BSWAP_U32(u32) RT_BSWAP_U32_C(u32)
1890	#elif defined(__GNUC__)
1891	# define RT_BSWAP_U32(u32) (__builtin_constant_p((u32)) \
1892	? RT_BSWAP_U32_C(u32) : ASMByteSwapU32(u32))
1893	#else
1894	# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
1895	#endif
1896
1897	/** @def RT_BSWAP_U16
1898	* Reverses the byte order of an uint16_t value. */
1899	#if 0
1900	# define RT_BSWAP_U16(u16) RT_BSWAP_U16_C(u16)
1901	#elif defined(__GNUC__)
1902	# define RT_BSWAP_U16(u16) (__builtin_constant_p((u16)) \
1903	? RT_BSWAP_U16_C(u16) : ASMByteSwapU16(u16))
1904	#else
1905	# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
1906	#endif
1907
1908
1909	/** @def RT_BSWAP_U64_C
1910	* Reverses the byte order of an uint64_t constant. */
1911	#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
1912
1913	/** @def RT_BSWAP_U32_C
1914	* Reverses the byte order of an uint32_t constant. */
1915	#define RT_BSWAP_U32_C(u32) RT_MAKE_U32_FROM_U8(RT_BYTE4(u32), RT_BYTE3(u32), RT_BYTE2(u32), RT_BYTE1(u32))
1916
1917	/** @def RT_BSWAP_U16_C
1918	* Reverses the byte order of an uint16_t constant. */
1919	#define RT_BSWAP_U16_C(u16) RT_MAKE_U16(RT_HIBYTE(u16), RT_LOBYTE(u16))
1920
1921
1922	/** @def RT_H2LE_U64
1923	* Converts an uint64_t value from host to little endian byte order. */
1924	#ifdef RT_BIG_ENDIAN
1925	# define RT_H2LE_U64(u64) RT_BSWAP_U64(u64)
1926	#else
1927	# define RT_H2LE_U64(u64) (u64)
1928	#endif
1929
1930	/** @def RT_H2LE_U64_C
1931	* Converts an uint64_t constant from host to little endian byte order. */
1932	#ifdef RT_BIG_ENDIAN
1933	# define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64)
1934	#else
1935	# define RT_H2LE_U64_C(u64) (u64)
1936	#endif
1937
1938	/** @def RT_H2LE_U32
1939	* Converts an uint32_t value from host to little endian byte order. */
1940	#ifdef RT_BIG_ENDIAN
1941	# define RT_H2LE_U32(u32) RT_BSWAP_U32(u32)
1942	#else
1943	# define RT_H2LE_U32(u32) (u32)
1944	#endif
1945
1946	/** @def RT_H2LE_U32_C
1947	* Converts an uint32_t constant from host to little endian byte order. */
1948	#ifdef RT_BIG_ENDIAN
1949	# define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32)
1950	#else
1951	# define RT_H2LE_U32_C(u32) (u32)
1952	#endif
1953
1954	/** @def RT_H2LE_U16
1955	* Converts an uint16_t value from host to little endian byte order. */
1956	#ifdef RT_BIG_ENDIAN
1957	# define RT_H2LE_U16(u16) RT_BSWAP_U16(u16)
1958	#else
1959	# define RT_H2LE_U16(u16) (u16)
1960	#endif
1961
1962	/** @def RT_H2LE_U16_C
1963	* Converts an uint16_t constant from host to little endian byte order. */
1964	#ifdef RT_BIG_ENDIAN
1965	# define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16)
1966	#else
1967	# define RT_H2LE_U16_C(u16) (u16)
1968	#endif
1969
1970
1971	/** @def RT_LE2H_U64
1972	* Converts an uint64_t value from little endian to host byte order. */
1973	#ifdef RT_BIG_ENDIAN
1974	# define RT_LE2H_U64(u64) RT_BSWAP_U64(u64)
1975	#else
1976	# define RT_LE2H_U64(u64) (u64)
1977	#endif
1978
1979	/** @def RT_LE2H_U64_C
1980	* Converts an uint64_t constant from little endian to host byte order. */
1981	#ifdef RT_BIG_ENDIAN
1982	# define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
1983	#else
1984	# define RT_LE2H_U64_C(u64) (u64)
1985	#endif
1986
1987	/** @def RT_LE2H_U32
1988	* Converts an uint32_t value from little endian to host byte order. */
1989	#ifdef RT_BIG_ENDIAN
1990	# define RT_LE2H_U32(u32) RT_BSWAP_U32(u32)
1991	#else
1992	# define RT_LE2H_U32(u32) (u32)
1993	#endif
1994
1995	/** @def RT_LE2H_U32_C
1996	* Converts an uint32_t constant from little endian to host byte order. */
1997	#ifdef RT_BIG_ENDIAN
1998	# define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
1999	#else
2000	# define RT_LE2H_U32_C(u32) (u32)
2001	#endif
2002
2003	/** @def RT_LE2H_U16
2004	* Converts an uint16_t value from little endian to host byte order. */
2005	#ifdef RT_BIG_ENDIAN
2006	# define RT_LE2H_U16(u16) RT_BSWAP_U16(u16)
2007	#else
2008	# define RT_LE2H_U16(u16) (u16)
2009	#endif
2010
2011	/** @def RT_LE2H_U16_C
2012	* Converts an uint16_t constant from little endian to host byte order. */
2013	#ifdef RT_BIG_ENDIAN
2014	# define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2015	#else
2016	# define RT_LE2H_U16_C(u16) (u16)
2017	#endif
2018
2019
2020	/** @def RT_H2BE_U64
2021	* Converts an uint64_t value from host to big endian byte order. */
2022	#ifdef RT_BIG_ENDIAN
2023	# define RT_H2BE_U64(u64) (u64)
2024	#else
2025	# define RT_H2BE_U64(u64) RT_BSWAP_U64(u64)
2026	#endif
2027
2028	/** @def RT_H2BE_U64_C
2029	* Converts an uint64_t constant from host to big endian byte order. */
2030	#ifdef RT_BIG_ENDIAN
2031	# define RT_H2BE_U64_C(u64) (u64)
2032	#else
2033	# define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64)
2034	#endif
2035
2036	/** @def RT_H2BE_U32
2037	* Converts an uint32_t value from host to big endian byte order. */
2038	#ifdef RT_BIG_ENDIAN
2039	# define RT_H2BE_U32(u32) (u32)
2040	#else
2041	# define RT_H2BE_U32(u32) RT_BSWAP_U32(u32)
2042	#endif
2043
2044	/** @def RT_H2BE_U32_C
2045	* Converts an uint32_t constant from host to big endian byte order. */
2046	#ifdef RT_BIG_ENDIAN
2047	# define RT_H2BE_U32_C(u32) (u32)
2048	#else
2049	# define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32)
2050	#endif
2051
2052	/** @def RT_H2BE_U16
2053	* Converts an uint16_t value from host to big endian byte order. */
2054	#ifdef RT_BIG_ENDIAN
2055	# define RT_H2BE_U16(u16) (u16)
2056	#else
2057	# define RT_H2BE_U16(u16) RT_BSWAP_U16(u16)
2058	#endif
2059
2060	/** @def RT_H2BE_U16_C
2061	* Converts an uint16_t constant from host to big endian byte order. */
2062	#ifdef RT_BIG_ENDIAN
2063	# define RT_H2BE_U16_C(u16) (u16)
2064	#else
2065	# define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16)
2066	#endif
2067
2068	/** @def RT_BE2H_U64
2069	* Converts an uint64_t value from big endian to host byte order. */
2070	#ifdef RT_BIG_ENDIAN
2071	# define RT_BE2H_U64(u64) (u64)
2072	#else
2073	# define RT_BE2H_U64(u64) RT_BSWAP_U64(u64)
2074	#endif
2075
2076	/** @def RT_BE2H_U64
2077	* Converts an uint64_t constant from big endian to host byte order. */
2078	#ifdef RT_BIG_ENDIAN
2079	# define RT_BE2H_U64_C(u64) (u64)
2080	#else
2081	# define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
2082	#endif
2083
2084	/** @def RT_BE2H_U32
2085	* Converts an uint32_t value from big endian to host byte order. */
2086	#ifdef RT_BIG_ENDIAN
2087	# define RT_BE2H_U32(u32) (u32)
2088	#else
2089	# define RT_BE2H_U32(u32) RT_BSWAP_U32(u32)
2090	#endif
2091
2092	/** @def RT_BE2H_U32_C
2093	* Converts an uint32_t value from big endian to host byte order. */
2094	#ifdef RT_BIG_ENDIAN
2095	# define RT_BE2H_U32_C(u32) (u32)
2096	#else
2097	# define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
2098	#endif
2099
2100	/** @def RT_BE2H_U16
2101	* Converts an uint16_t value from big endian to host byte order. */
2102	#ifdef RT_BIG_ENDIAN
2103	# define RT_BE2H_U16(u16) (u16)
2104	#else
2105	# define RT_BE2H_U16(u16) RT_BSWAP_U16(u16)
2106	#endif
2107
2108	/** @def RT_BE2H_U16_C
2109	* Converts an uint16_t constant from big endian to host byte order. */
2110	#ifdef RT_BIG_ENDIAN
2111	# define RT_BE2H_U16_C(u16) (u16)
2112	#else
2113	# define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
2114	#endif
2115
2116
2117	/** @def RT_H2N_U64
2118	* Converts an uint64_t value from host to network byte order. */
2119	#define RT_H2N_U64(u64) RT_H2BE_U64(u64)
2120
2121	/** @def RT_H2N_U64_C
2122	* Converts an uint64_t constant from host to network byte order. */
2123	#define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64)
2124
2125	/** @def RT_H2N_U32
2126	* Converts an uint32_t value from host to network byte order. */
2127	#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
2128
2129	/** @def RT_H2N_U32_C
2130	* Converts an uint32_t constant from host to network byte order. */
2131	#define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32)
2132
2133	/** @def RT_H2N_U16
2134	* Converts an uint16_t value from host to network byte order. */
2135	#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
2136
2137	/** @def RT_H2N_U16_C
2138	* Converts an uint16_t constant from host to network byte order. */
2139	#define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16)
2140
2141	/** @def RT_N2H_U64
2142	* Converts an uint64_t value from network to host byte order. */
2143	#define RT_N2H_U64(u64) RT_BE2H_U64(u64)
2144
2145	/** @def RT_N2H_U64_C
2146	* Converts an uint64_t constant from network to host byte order. */
2147	#define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64)
2148
2149	/** @def RT_N2H_U32
2150	* Converts an uint32_t value from network to host byte order. */
2151	#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
2152
2153	/** @def RT_N2H_U32_C
2154	* Converts an uint32_t constant from network to host byte order. */
2155	#define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32)
2156
2157	/** @def RT_N2H_U16
2158	* Converts an uint16_t value from network to host byte order. */
2159	#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
2160
2161	/** @def RT_N2H_U16_C
2162	* Converts an uint16_t value from network to host byte order. */
2163	#define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16)
2164
2165
2166	/*
2167	* The BSD sys/param.h + machine/param.h file is a major source of
2168	* namespace pollution. Kill off some of the worse ones unless we're
2169	* compiling kernel code.
2170	*/
2171	#if defined(RT_OS_DARWIN) \
2172	&& !defined(KERNEL) \
2173	&& !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
2174	&& ( defined(_SYS_PARAM_H_) \|\| defined(_I386_PARAM_H_) )
2175	/* sys/param.h: */
2176	# undef PSWP
2177	# undef PVM
2178	# undef PINOD
2179	# undef PRIBO
2180	# undef PVFS
2181	# undef PZERO
2182	# undef PSOCK
2183	# undef PWAIT
2184	# undef PLOCK
2185	# undef PPAUSE
2186	# undef PUSER
2187	# undef PRIMASK
2188	# undef MINBUCKET
2189	# undef MAXALLOCSAVE
2190	# undef FSHIFT
2191	# undef FSCALE
2192
2193	/* i386/machine.h: */
2194	# undef ALIGN
2195	# undef ALIGNBYTES
2196	# undef DELAY
2197	# undef STATUS_WORD
2198	# undef USERMODE
2199	# undef BASEPRI
2200	# undef MSIZE
2201	# undef CLSIZE
2202	# undef CLSIZELOG2
2203	#endif
2204
2205	/** @def NIL_OFFSET
2206	* NIL offset.
2207	* Whenever we use offsets instead of pointers to save space and relocation effort
2208	* NIL_OFFSET shall be used as the equivalent to NULL.
2209	*/
2210	#define NIL_OFFSET (~0U)
2211
2212	/** @def NOREF
2213	* Keeps the compiler from bitching about an unused parameter.
2214	*/
2215	#define NOREF(var) (void)(var)
2216
2217	/** @def RT_BREAKPOINT
2218	* Emit a debug breakpoint instruction.
2219	*
2220	* @remarks In the x86/amd64 gnu world we add a nop instruction after the int3
2221	* to force gdb to remain at the int3 source line.
2222	* @remarks The L4 kernel will try make sense of the breakpoint, thus the jmp on
2223	* x86/amd64.
2224	*/
2225	#ifdef __GNUC__
2226	# if defined(RT_ARCH_AMD64) \|\| defined(RT_ARCH_X86)
2227	# if !defined(__L4ENV__)
2228	# define RT_BREAKPOINT() __asm__ __volatile__("int $3\n\tnop\n\t")
2229	# else
2230	# define RT_BREAKPOINT() __asm__ __volatile__("int3; jmp 1f; 1:\n\t")
2231	# endif
2232	# elif defined(RT_ARCH_SPARC64)
2233	# define RT_BREAKPOINT() __asm__ __volatile__("illtrap 0\n\t") /** @todo Sparc64: this is just a wild guess. */
2234	# elif defined(RT_ARCH_SPARC)
2235	# define RT_BREAKPOINT() __asm__ __volatile__("unimp 0\n\t") /** @todo Sparc: this is just a wild guess (same as Sparc64, just different name). */
2236	# endif
2237	#endif
2238	#ifdef _MSC_VER
2239	# define RT_BREAKPOINT() __debugbreak()
2240	#endif
2241	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
2242	# define RT_BREAKPOINT() __interrupt(3)
2243	#endif
2244	#ifndef RT_BREAKPOINT
2245	# error "This compiler/arch is not supported!"
2246	#endif
2247
2248
2249	/** @defgroup grp_rt_cdefs_size Size Constants
2250	* (Of course, these are binary computer terms, not SI.)
2251	* @{
2252	*/
2253	/** 1 K (Kilo) (1 024). */
2254	#define _1K 0x00000400
2255	/** 2 K (Kilo) (2 048). */
2256	#define _2K 0x00000800
2257	/** 4 K (Kilo) (4 096). */
2258	#define _4K 0x00001000
2259	/** 8 K (Kilo) (8 192). */
2260	#define _8K 0x00002000
2261	/** 16 K (Kilo) (16 384). */
2262	#define _16K 0x00004000
2263	/** 32 K (Kilo) (32 678). */
2264	#define _32K 0x00008000
2265	/** 64 K (Kilo) (65 536). */
2266	#define _64K 0x00010000
2267	/** 128 K (Kilo) (131 072). */
2268	#define _128K 0x00020000
2269	/** 256 K (Kilo) (262 144). */
2270	#define _256K 0x00040000
2271	/** 512 K (Kilo) (524 288). */
2272	#define _512K 0x00080000
2273	/** 1 M (Mega) (1 048 576). */
2274	#define _1M 0x00100000
2275	/** 2 M (Mega) (2 097 152). */
2276	#define _2M 0x00200000
2277	/** 4 M (Mega) (4 194 304). */
2278	#define _4M 0x00400000
2279	/** 1 G (Giga) (1 073 741 824). (32-bit) */
2280	#define _1G 0x40000000
2281	/** 1 G (Giga) (1 073 741 824). (64-bit) */
2282	#define _1G64 0x40000000LL
2283	/** 2 G (Giga) (2 147 483 648). (32-bit) */
2284	#define _2G32 0x80000000U
2285	/** 2 G (Giga) (2 147 483 648). (64-bit) */
2286	#define _2G 0x0000000080000000LL
2287	/** 4 G (Giga) (4 294 967 296). */
2288	#define _4G 0x0000000100000000LL
2289	/** 1 T (Tera) (1 099 511 627 776). */
2290	#define _1T 0x0000010000000000LL
2291	/** 1 P (Peta) (1 125 899 906 842 624). */
2292	#define _1P 0x0004000000000000LL
2293	/** 1 E (Exa) (1 152 921 504 606 846 976). */
2294	#define _1E 0x1000000000000000LL
2295	/** 2 E (Exa) (2 305 843 009 213 693 952). */
2296	#define _2E 0x2000000000000000ULL
2297	/** @} */
2298
2299	/** @defgroup grp_rt_cdefs_decimal_grouping Decimal Constant Grouping Macros
2300	* @{ */
2301	#define RT_D1(g1) g1
2302	#define RT_D2(g1, g2) g1#g2
2303	#define RT_D3(g1, g2, g3) g1#g2#g3
2304	#define RT_D4(g1, g2, g3, g4) g1#g2#g3#g4
2305	#define RT_D5(g1, g2, g3, g4, g5) g1#g2#g3#g4#g5
2306	#define RT_D6(g1, g2, g3, g4, g5, g6) g1#g2#g3#g4#g5#g6
2307	#define RT_D7(g1, g2, g3, g4, g5, g6, g7) g1#g2#g3#g4#g5#g6#g7
2308
2309	#define RT_D1_U(g1) UINT32_C(g1)
2310	#define RT_D2_U(g1, g2) UINT32_C(g1#g2)
2311	#define RT_D3_U(g1, g2, g3) UINT32_C(g1#g2#g3)
2312	#define RT_D4_U(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2313	#define RT_D5_U(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2314	#define RT_D6_U(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2315	#define RT_D7_U(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2316
2317	#define RT_D1_S(g1) INT32_C(g1)
2318	#define RT_D2_S(g1, g2) INT32_C(g1#g2)
2319	#define RT_D3_S(g1, g2, g3) INT32_C(g1#g2#g3)
2320	#define RT_D4_S(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2321	#define RT_D5_S(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2322	#define RT_D6_S(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2323	#define RT_D7_S(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2324
2325	#define RT_D1_U32(g1) UINT32_C(g1)
2326	#define RT_D2_U32(g1, g2) UINT32_C(g1#g2)
2327	#define RT_D3_U32(g1, g2, g3) UINT32_C(g1#g2#g3)
2328	#define RT_D4_U32(g1, g2, g3, g4) UINT32_C(g1#g2#g3#g4)
2329
2330	#define RT_D1_S32(g1) INT32_C(g1)
2331	#define RT_D2_S32(g1, g2) INT32_C(g1#g2)
2332	#define RT_D3_S32(g1, g2, g3) INT32_C(g1#g2#g3)
2333	#define RT_D4_S32(g1, g2, g3, g4) INT32_C(g1#g2#g3#g4)
2334
2335	#define RT_D1_U64(g1) UINT64_C(g1)
2336	#define RT_D2_U64(g1, g2) UINT64_C(g1#g2)
2337	#define RT_D3_U64(g1, g2, g3) UINT64_C(g1#g2#g3)
2338	#define RT_D4_U64(g1, g2, g3, g4) UINT64_C(g1#g2#g3#g4)
2339	#define RT_D5_U64(g1, g2, g3, g4, g5) UINT64_C(g1#g2#g3#g4#g5)
2340	#define RT_D6_U64(g1, g2, g3, g4, g5, g6) UINT64_C(g1#g2#g3#g4#g5#g6)
2341	#define RT_D7_U64(g1, g2, g3, g4, g5, g6, g7) UINT64_C(g1#g2#g3#g4#g5#g6#g7)
2342
2343	#define RT_D1_S64(g1) INT64_C(g1)
2344	#define RT_D2_S64(g1, g2) INT64_C(g1#g2)
2345	#define RT_D3_S64(g1, g2, g3) INT64_C(g1#g2#g3)
2346	#define RT_D4_S64(g1, g2, g3, g4) INT64_C(g1#g2#g3#g4)
2347	#define RT_D5_S64(g1, g2, g3, g4, g5) INT64_C(g1#g2#g3#g4#g5)
2348	#define RT_D6_S64(g1, g2, g3, g4, g5, g6) INT64_C(g1#g2#g3#g4#g5#g6)
2349	#define RT_D7_S64(g1, g2, g3, g4, g5, g6, g7) INT64_C(g1#g2#g3#g4#g5#g6#g7)
2350	/** @} */
2351
2352
2353	/** @defgroup grp_rt_cdefs_time Time Constants
2354	* @{
2355	*/
2356	/** 1 hour expressed in nanoseconds (64-bit). */
2357	#define RT_NS_1HOUR UINT64_C(3600000000000)
2358	/** 1 minute expressed in nanoseconds (64-bit). */
2359	#define RT_NS_1MIN UINT64_C(60000000000)
2360	/** 45 second expressed in nanoseconds. */
2361	#define RT_NS_45SEC UINT64_C(45000000000)
2362	/** 30 second expressed in nanoseconds. */
2363	#define RT_NS_30SEC UINT64_C(30000000000)
2364	/** 20 second expressed in nanoseconds. */
2365	#define RT_NS_20SEC UINT64_C(20000000000)
2366	/** 15 second expressed in nanoseconds. */
2367	#define RT_NS_15SEC UINT64_C(15000000000)
2368	/** 10 second expressed in nanoseconds. */
2369	#define RT_NS_10SEC UINT64_C(10000000000)
2370	/** 1 second expressed in nanoseconds. */
2371	#define RT_NS_1SEC UINT32_C(1000000000)
2372	/** 100 millsecond expressed in nanoseconds. */
2373	#define RT_NS_100MS UINT32_C(100000000)
2374	/** 10 millsecond expressed in nanoseconds. */
2375	#define RT_NS_10MS UINT32_C(10000000)
2376	/** 1 millsecond expressed in nanoseconds. */
2377	#define RT_NS_1MS UINT32_C(1000000)
2378	/** 100 microseconds expressed in nanoseconds. */
2379	#define RT_NS_100US UINT32_C(100000)
2380	/** 10 microseconds expressed in nanoseconds. */
2381	#define RT_NS_10US UINT32_C(10000)
2382	/** 1 microsecond expressed in nanoseconds. */
2383	#define RT_NS_1US UINT32_C(1000)
2384
2385	/** 1 second expressed in nanoseconds - 64-bit type. */
2386	#define RT_NS_1SEC_64 UINT64_C(1000000000)
2387	/** 100 millsecond expressed in nanoseconds - 64-bit type. */
2388	#define RT_NS_100MS_64 UINT64_C(100000000)
2389	/** 10 millsecond expressed in nanoseconds - 64-bit type. */
2390	#define RT_NS_10MS_64 UINT64_C(10000000)
2391	/** 1 millsecond expressed in nanoseconds - 64-bit type. */
2392	#define RT_NS_1MS_64 UINT64_C(1000000)
2393	/** 100 microseconds expressed in nanoseconds - 64-bit type. */
2394	#define RT_NS_100US_64 UINT64_C(100000)
2395	/** 10 microseconds expressed in nanoseconds - 64-bit type. */
2396	#define RT_NS_10US_64 UINT64_C(10000)
2397	/** 1 microsecond expressed in nanoseconds - 64-bit type. */
2398	#define RT_NS_1US_64 UINT64_C(1000)
2399
2400	/** 1 hour expressed in microseconds. */
2401	#define RT_US_1HOUR UINT32_C(3600000000)
2402	/** 1 minute expressed in microseconds. */
2403	#define RT_US_1MIN UINT32_C(60000000)
2404	/** 1 second expressed in microseconds. */
2405	#define RT_US_1SEC UINT32_C(1000000)
2406	/** 100 millsecond expressed in microseconds. */
2407	#define RT_US_100MS UINT32_C(100000)
2408	/** 10 millsecond expressed in microseconds. */
2409	#define RT_US_10MS UINT32_C(10000)
2410	/** 1 millsecond expressed in microseconds. */
2411	#define RT_US_1MS UINT32_C(1000)
2412
2413	/** 1 hour expressed in microseconds - 64-bit type. */
2414	#define RT_US_1HOUR_64 UINT64_C(3600000000)
2415	/** 1 minute expressed in microseconds - 64-bit type. */
2416	#define RT_US_1MIN_64 UINT64_C(60000000)
2417	/** 1 second expressed in microseconds - 64-bit type. */
2418	#define RT_US_1SEC_64 UINT64_C(1000000)
2419	/** 100 millsecond expressed in microseconds - 64-bit type. */
2420	#define RT_US_100MS_64 UINT64_C(100000)
2421	/** 10 millsecond expressed in microseconds - 64-bit type. */
2422	#define RT_US_10MS_64 UINT64_C(10000)
2423	/** 1 millsecond expressed in microseconds - 64-bit type. */
2424	#define RT_US_1MS_64 UINT64_C(1000)
2425
2426	/** 1 hour expressed in milliseconds. */
2427	#define RT_MS_1HOUR UINT32_C(3600000)
2428	/** 1 minute expressed in milliseconds. */
2429	#define RT_MS_1MIN UINT32_C(60000)
2430	/** 1 second expressed in milliseconds. */
2431	#define RT_MS_1SEC UINT32_C(1000)
2432
2433	/** 1 hour expressed in milliseconds - 64-bit type. */
2434	#define RT_MS_1HOUR_64 UINT64_C(3600000)
2435	/** 1 minute expressed in milliseconds - 64-bit type. */
2436	#define RT_MS_1MIN_64 UINT64_C(60000)
2437	/** 1 second expressed in milliseconds - 64-bit type. */
2438	#define RT_MS_1SEC_64 UINT64_C(1000)
2439
2440	/** The number of seconds per week. */
2441	#define RT_SEC_1WEEK UINT32_C(604800)
2442	/** The number of seconds per day. */
2443	#define RT_SEC_1DAY UINT32_C(86400)
2444	/** The number of seconds per hour. */
2445	#define RT_SEC_1HOUR UINT32_C(3600)
2446
2447	/** The number of seconds per week - 64-bit type. */
2448	#define RT_SEC_1WEEK_64 UINT64_C(604800)
2449	/** The number of seconds per day - 64-bit type. */
2450	#define RT_SEC_1DAY_64 UINT64_C(86400)
2451	/** The number of seconds per hour - 64-bit type. */
2452	#define RT_SEC_1HOUR_64 UINT64_C(3600)
2453	/** @} */
2454
2455
2456	/** @defgroup grp_rt_cdefs_dbgtype Debug Info Types
2457	* @{ */
2458	/** Other format. */
2459	#define RT_DBGTYPE_OTHER RT_BIT_32(0)
2460	/** Stabs. */
2461	#define RT_DBGTYPE_STABS RT_BIT_32(1)
2462	/** Debug With Arbitrary Record Format (DWARF). */
2463	#define RT_DBGTYPE_DWARF RT_BIT_32(2)
2464	/** Microsoft Codeview debug info. */
2465	#define RT_DBGTYPE_CODEVIEW RT_BIT_32(3)
2466	/** Watcom debug info. */
2467	#define RT_DBGTYPE_WATCOM RT_BIT_32(4)
2468	/** IBM High Level Language debug info. */
2469	#define RT_DBGTYPE_HLL RT_BIT_32(5)
2470	/** Old OS/2 and Windows symbol file. */
2471	#define RT_DBGTYPE_SYM RT_BIT_32(6)
2472	/** Map file. */
2473	#define RT_DBGTYPE_MAP RT_BIT_32(7)
2474	/** @} */
2475
2476
2477	/** @defgroup grp_rt_cdefs_exetype Executable Image Types
2478	* @{ */
2479	/** Some other format. */
2480	#define RT_EXETYPE_OTHER RT_BIT_32(0)
2481	/** Portable Executable. */
2482	#define RT_EXETYPE_PE RT_BIT_32(1)
2483	/** Linear eXecutable. */
2484	#define RT_EXETYPE_LX RT_BIT_32(2)
2485	/** Linear Executable. */
2486	#define RT_EXETYPE_LE RT_BIT_32(3)
2487	/** New Executable. */
2488	#define RT_EXETYPE_NE RT_BIT_32(4)
2489	/** DOS Executable (Mark Zbikowski). */
2490	#define RT_EXETYPE_MZ RT_BIT_32(5)
2491	/** COM Executable. */
2492	#define RT_EXETYPE_COM RT_BIT_32(6)
2493	/** a.out Executable. */
2494	#define RT_EXETYPE_AOUT RT_BIT_32(7)
2495	/** Executable and Linkable Format. */
2496	#define RT_EXETYPE_ELF RT_BIT_32(8)
2497	/** Mach-O Executable (including FAT ones). */
2498	#define RT_EXETYPE_MACHO RT_BIT_32(9)
2499	/** TE from UEFI. */
2500	#define RT_EXETYPE_TE RT_BIT_32(9)
2501	/** @} */
2502
2503
2504	/** @def VALID_PTR
2505	* Pointer validation macro.
2506	* @param ptr The pointer.
2507	*/
2508	#if defined(RT_ARCH_AMD64)
2509	# ifdef IN_RING3
2510	# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
2511	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
2512	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
2513	# elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */
2514	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
2515	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
2516	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
2517	# else
2518	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
2519	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
2520	# endif
2521	# else /* !IN_RING3 */
2522	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
2523	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
2524	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
2525	# endif /* !IN_RING3 */
2526
2527	#elif defined(RT_ARCH_X86)
2528	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
2529
2530	#elif defined(RT_ARCH_SPARC64)
2531	# ifdef IN_RING3
2532	# if defined(RT_OS_SOLARIS)
2533	/** Sparc64 user mode: According to Figure 9.4 in solaris internals */
2534	/** @todo # define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80004000U >= 0x80004000U + 0x100000000ULL ) - figure this. */
2535	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x80000000U >= 0x80000000U + 0x100000000ULL )
2536	# else
2537	# error "Port me"
2538	# endif
2539	# else /* !IN_RING3 */
2540	# if defined(RT_OS_SOLARIS)
2541	/** @todo Sparc64 kernel mode: This is according to Figure 11.1 in solaris
2542	* internals. Verify in sources. */
2543	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) >= 0x01000000U )
2544	# else
2545	# error "Port me"
2546	# endif
2547	# endif /* !IN_RING3 */
2548
2549	#elif defined(RT_ARCH_SPARC)
2550	# ifdef IN_RING3
2551	# ifdef RT_OS_SOLARIS
2552	/** Sparc user mode: According to
2553	* http://cvs.opensolaris.org/source/xref/onnv/onnv-gate/usr/src/uts/sun4/os/startup.c#510 */
2554	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x400000U >= 0x400000U + 0x2000U )
2555
2556	# else
2557	# error "Port me"
2558	# endif
2559	# else /* !IN_RING3 */
2560	# ifdef RT_OS_SOLARIS
2561	/** @todo Sparc kernel mode: Check the sources! */
2562	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
2563	# else
2564	# error "Port me"
2565	# endif
2566	# endif /* !IN_RING3 */
2567
2568	#elif defined(RT_ARCH_ARM)
2569	/* ASSUMES that at least the last and first 4K are out of bounds. */
2570	# define RT_VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
2571
2572	#else
2573	# error "Architecture identifier missing / not implemented."
2574	#endif
2575
2576	/** Old name for RT_VALID_PTR. */
2577	#define VALID_PTR(ptr) RT_VALID_PTR(ptr)
2578
2579	/** @def RT_VALID_ALIGNED_PTR
2580	* Pointer validation macro that also checks the alignment.
2581	* @param ptr The pointer.
2582	* @param align The alignment, must be a power of two.
2583	*/
2584	#define RT_VALID_ALIGNED_PTR(ptr, align) \
2585	( !((uintptr_t)(ptr) & (uintptr_t)((align) - 1)) \
2586	&& VALID_PTR(ptr) )
2587
2588
2589	/** @def VALID_PHYS32
2590	* 32 bits physical address validation macro.
2591	* @param Phys The RTGCPHYS address.
2592	*/
2593	#define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G )
2594
2595	/** @def N_
2596	* The \#define N_ is used to mark a string for translation. This is usable in
2597	* any part of the code, as it is only used by the tools that create message
2598	* catalogs. This macro is a no-op as far as the compiler and code generation
2599	* is concerned.
2600	*
2601	* If you want to both mark a string for translation and translate it, use _().
2602	*/
2603	#define N_(s) (s)
2604
2605	/** @def _
2606	* The \#define _ is used to mark a string for translation and to translate it
2607	* in one step.
2608	*
2609	* If you want to only mark a string for translation, use N_().
2610	*/
2611	#define _(s) gettext(s)
2612
2613
2614	/** @def __PRETTY_FUNCTION__
2615	* With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
2616	* for the other compilers.
2617	*/
2618	#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
2619	# ifdef _MSC_VER
2620	# define __PRETTY_FUNCTION__ __FUNCSIG__
2621	# else
2622	# define __PRETTY_FUNCTION__ __FUNCTION__
2623	# endif
2624	#endif
2625
2626
2627	/** @def RT_STRICT
2628	* The \#define RT_STRICT controls whether or not assertions and other runtime
2629	* checks should be compiled in or not. This is defined when DEBUG is defined.
2630	* If RT_NO_STRICT is defined, it will unconditionally be undefined.
2631	*
2632	* If you want assertions which are not subject to compile time options use
2633	* the AssertRelease*() flavors.
2634	*/
2635	#if !defined(RT_STRICT) && defined(DEBUG)
2636	# define RT_STRICT
2637	#endif
2638	#ifdef RT_NO_STRICT
2639	# undef RT_STRICT
2640	#endif
2641
2642	/** @todo remove this: */
2643	#if !defined(RT_LOCK_STRICT) && !defined(DEBUG_bird)
2644	# define RT_LOCK_NO_STRICT
2645	#endif
2646	#if !defined(RT_LOCK_STRICT_ORDER) && !defined(DEBUG_bird)
2647	# define RT_LOCK_NO_STRICT_ORDER
2648	#endif
2649
2650	/** @def RT_LOCK_STRICT
2651	* The \#define RT_LOCK_STRICT controls whether deadlock detection and related
2652	* checks are done in the lock and semaphore code. It is by default enabled in
2653	* RT_STRICT builds, but this behavior can be overridden by defining
2654	* RT_LOCK_NO_STRICT. */
2655	#if !defined(RT_LOCK_STRICT) && !defined(RT_LOCK_NO_STRICT) && defined(RT_STRICT)
2656	# define RT_LOCK_STRICT
2657	#endif
2658	/** @def RT_LOCK_NO_STRICT
2659	* The \#define RT_LOCK_NO_STRICT disables RT_LOCK_STRICT. */
2660	#if defined(RT_LOCK_NO_STRICT) && defined(RT_LOCK_STRICT)
2661	# undef RT_LOCK_STRICT
2662	#endif
2663
2664	/** @def RT_LOCK_STRICT_ORDER
2665	* The \#define RT_LOCK_STRICT_ORDER controls whether locking order is checked
2666	* by the lock and semaphore code. It is by default enabled in RT_STRICT
2667	* builds, but this behavior can be overridden by defining
2668	* RT_LOCK_NO_STRICT_ORDER. */
2669	#if !defined(RT_LOCK_STRICT_ORDER) && !defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_STRICT)
2670	# define RT_LOCK_STRICT_ORDER
2671	#endif
2672	/** @def RT_LOCK_NO_STRICT_ORDER
2673	* The \#define RT_LOCK_NO_STRICT_ORDER disables RT_LOCK_STRICT_ORDER. */
2674	#if defined(RT_LOCK_NO_STRICT_ORDER) && defined(RT_LOCK_STRICT_ORDER)
2675	# undef RT_LOCK_STRICT_ORDER
2676	#endif
2677
2678
2679	/** Source position. */
2680	#define RT_SRC_POS __FILE__, __LINE__, RT_GCC_EXTENSION __PRETTY_FUNCTION__
2681
2682	/** Source position declaration. */
2683	#define RT_SRC_POS_DECL const char pszFile, unsigned iLine, const char pszFunction
2684
2685	/** Source position arguments. */
2686	#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
2687
2688	/** Applies NOREF() to the source position arguments. */
2689	#define RT_SRC_POS_NOREF() do { NOREF(pszFile); NOREF(iLine); NOREF(pszFunction); } while (0)
2690
2691
2692	/** @def RT_INLINE_ASM_EXTERNAL
2693	* Defined as 1 if the compiler does not support inline assembly.
2694	* The ASM* functions will then be implemented in external .asm files.
2695	*/
2696	#if (defined(_MSC_VER) && defined(RT_ARCH_AMD64)) \
2697	\|\| (!defined(RT_ARCH_AMD64) && !defined(RT_ARCH_X86))
2698	# define RT_INLINE_ASM_EXTERNAL 1
2699	#else
2700	# define RT_INLINE_ASM_EXTERNAL 0
2701	#endif
2702
2703	/** @def RT_INLINE_ASM_GNU_STYLE
2704	* Defined as 1 if the compiler understands GNU style inline assembly.
2705	*/
2706	#if defined(_MSC_VER)
2707	# define RT_INLINE_ASM_GNU_STYLE 0
2708	#else
2709	# define RT_INLINE_ASM_GNU_STYLE 1
2710	#endif
2711
2712	/** @def RT_INLINE_ASM_USES_INTRIN
2713	* Defined as the major MSC version if the compiler have and uses intrin.h.
2714	* Otherwise it is 0. */
2715	#ifdef _MSC_VER
2716	# if _MSC_VER >= 1700 /* Visual C++ v11.0 / 2012 */
2717	# define RT_INLINE_ASM_USES_INTRIN 17
2718	# elif _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
2719	# define RT_INLINE_ASM_USES_INTRIN 16
2720	# elif _MSC_VER >= 1500 /* Visual C++ v9.0 / 2008 */
2721	# define RT_INLINE_ASM_USES_INTRIN 15
2722	# elif _MSC_VER >= 1400 /* Visual C++ v8.0 / 2005 */
2723	# define RT_INLINE_ASM_USES_INTRIN 14
2724	# endif
2725	#endif
2726	#ifndef RT_INLINE_ASM_USES_INTRIN
2727	# define RT_INLINE_ASM_USES_INTRIN 0
2728	#endif
2729
2730	/** @def RT_COMPILER_SUPPORTS_LAMBDA
2731	* If the defined, the compiler supports lambda expressions. These expressions
2732	* are useful for embedding assertions and type checks into macros. */
2733	#if defined(_MSC_VER) && defined(__cplusplus)
2734	# if _MSC_VER >= 1600 /* Visual C++ v10.0 / 2010 */
2735	# define RT_COMPILER_SUPPORTS_LAMBDA
2736	# endif
2737	#elif defined(__GNUC__) && defined(__cplusplus)
2738	/* 4.5 or later, I think, if in ++11 mode... */
2739	#endif
2740
2741	/** @} */
2742
2743
2744	/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
2745	* @ingroup grp_rt_cdefs
2746	* @{
2747	*/
2748
2749	#ifdef __cplusplus
2750
2751	/** @def DECLEXPORT_CLASS
2752	* How to declare an exported class. Place this macro after the 'class'
2753	* keyword in the declaration of every class you want to export.
2754	*
2755	* @note It is necessary to use this macro even for inner classes declared
2756	* inside the already exported classes. This is a GCC specific requirement,
2757	* but it seems not to harm other compilers.
2758	*/
2759	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
2760	# define DECLEXPORT_CLASS __declspec(dllexport)
2761	#elif defined(RT_USE_VISIBILITY_DEFAULT)
2762	# define DECLEXPORT_CLASS __attribute__((visibility("default")))
2763	#else
2764	# define DECLEXPORT_CLASS
2765	#endif
2766
2767	/** @def DECLIMPORT_CLASS
2768	* How to declare an imported class Place this macro after the 'class'
2769	* keyword in the declaration of every class you want to export.
2770	*
2771	* @note It is necessary to use this macro even for inner classes declared
2772	* inside the already exported classes. This is a GCC specific requirement,
2773	* but it seems not to harm other compilers.
2774	*/
2775	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
2776	# define DECLIMPORT_CLASS __declspec(dllimport)
2777	#elif defined(RT_USE_VISIBILITY_DEFAULT)
2778	# define DECLIMPORT_CLASS __attribute__((visibility("default")))
2779	#else
2780	# define DECLIMPORT_CLASS
2781	#endif
2782
2783	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
2784	* Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
2785	* resolver. The following snippet clearly demonstrates the code causing this
2786	* error:
2787	* @code
2788	* class A
2789	* {
2790	* public:
2791	* operator bool() const { return false; }
2792	* operator int*() const { return NULL; }
2793	* };
2794	* int main()
2795	* {
2796	* A a;
2797	* if (!a);
2798	* if (a && 0);
2799	* return 0;
2800	* }
2801	* @endcode
2802	* The code itself seems pretty valid to me and GCC thinks the same.
2803	*
2804	* This macro fixes the compiler error by explicitly overloading implicit
2805	* global operators !, && and \|\| that take the given class instance as one of
2806	* their arguments.
2807	*
2808	* The best is to use this macro right after the class declaration.
2809	*
2810	* @note The macro expands to nothing for compilers other than MSVC.
2811	*
2812	* @param Cls Class to apply the workaround to
2813	*/
2814	#if defined(_MSC_VER)
2815	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
2816	inline bool operator! (const Cls &that) { return !bool (that); } \
2817	inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
2818	inline bool operator\|\| (const Cls &that, bool b) { return bool (that) \|\| b; } \
2819	inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
2820	inline bool operator\|\| (bool b, const Cls &that) { return b \|\| bool (that); }
2821	#else
2822	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
2823	#endif
2824
2825	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
2826	* Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
2827	*
2828	* @param Tpl Name of the template class to apply the workaround to
2829	* @param ArgsDecl arguments of the template, as declared in \|<>\| after the
2830	* \|template\| keyword, including \|<>\|
2831	* @param Args arguments of the template, as specified in \|<>\| after the
2832	* template class name when using the, including \|<>\|
2833	*
2834	* Example:
2835	* @code
2836	* // template class declaration
2837	* template <class C>
2838	* class Foo { ... };
2839	* // applied workaround
2840	* WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
2841	* @endcode
2842	*/
2843	#if defined(_MSC_VER)
2844	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
2845	template ArgsDecl \
2846	inline bool operator! (const Tpl Args &that) { return !bool (that); } \
2847	template ArgsDecl \
2848	inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
2849	template ArgsDecl \
2850	inline bool operator\|\| (const Tpl Args &that, bool b) { return bool (that) \|\| b; } \
2851	template ArgsDecl \
2852	inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
2853	template ArgsDecl \
2854	inline bool operator\|\| (bool b, const Tpl Args &that) { return b \|\| bool (that); }
2855	#else
2856	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
2857	#endif
2858
2859
2860	/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
2861	* Declares the copy constructor and the assignment operation as inlined no-ops
2862	* (non-existent functions) for the given class. Use this macro inside the
2863	* private section if you want to effectively disable these operations for your
2864	* class.
2865	*
2866	* @param Cls class name to declare for
2867	*/
2868
2869	#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
2870	inline Cls (const Cls &); \
2871	inline Cls &operator= (const Cls &);
2872
2873
2874	/** @def DECLARE_CLS_NEW_DELETE_NOOP
2875	* Declares the new and delete operations as no-ops (non-existent functions)
2876	* for the given class. Use this macro inside the private section if you want
2877	* to effectively limit creating class instances on the stack only.
2878	*
2879	* @note The destructor of the given class must not be virtual, otherwise a
2880	* compile time error will occur. Note that this is not a drawback: having
2881	* the virtual destructor for a stack-based class is absolutely useless
2882	* (the real class of the stack-based instance is always known to the compiler
2883	* at compile time, so it will always call the correct destructor).
2884	*
2885	* @param Cls class name to declare for
2886	*/
2887	#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
2888	inline static void *operator new (size_t); \
2889	inline static void operator delete (void *);
2890
2891	#endif /* __cplusplus */
2892
2893	/** @} */
2894
2895	#endif
2896

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

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

Download in other formats: