cdefs.h@ 57944

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

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

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

Download in other formats: