cdefs.h@ 57078

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

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

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

Download in other formats: