cdefs.h@ 19167

Last change on this file since 19167 was 19167, checked in by vboxsync, 16 years ago
iprt/cdefs.h,RTLdr: Added an generic RT_NOTHING macro to fixing issues like r46334.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 54.4 KB

Line
1	/** @file
2	* IPRT - Common C and C++ definitions.
3	*/
4
5	/*
6	* Copyright (C) 2006-2009 Sun Microsystems, Inc.
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	* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
26	* Clara, CA 95054 USA or visit http://www.sun.com if you need
27	* additional information or have any questions.
28	*/
29
30	#ifndef ___iprt_cdefs_h
31	#define ___iprt_cdefs_h
32
33
34	/** @defgroup grp_rt_cdefs IPRT Common Definitions and Macros
35	* @{
36	*/
37
38	/*
39	* Include sys/cdefs.h if present, if not define the stuff we need.
40	*/
41	#ifdef HAVE_SYS_CDEFS_H
42	# if defined(RT_ARCH_LINUX) && defined(__KERNEL__)
43	# error "oops"
44	# endif
45	# include <sys/cdefs.h>
46	#else
47
48	/** @def __BEGIN_DECLS
49	* Used to start a block of function declarations which are shared
50	* between C and C++ program.
51	*/
52
53	/** @def __END_DECLS
54	* Used to end a block of function declarations which are shared
55	* between C and C++ program.
56	*/
57
58	#if defined(__cplusplus)
59	# define __BEGIN_DECLS extern "C" {
60	# define __END_DECLS }
61	#else
62	# define __BEGIN_DECLS
63	# define __END_DECLS
64	#endif
65
66	#endif
67
68
69	/*
70	* Shut up DOXYGEN warnings and guide it properly thru the code.
71	*/
72	#ifdef DOXYGEN_RUNNING
73	#define __AMD64__
74	#define __X86__
75	#define RT_ARCH_AMD64
76	#define RT_ARCH_X86
77	#define IN_RING0
78	#define IN_RING3
79	#define IN_RC
80	#define IN_RC
81	#define IN_RT_GC
82	#define IN_RT_R0
83	#define IN_RT_R3
84	#define IN_RT_STATIC
85	#define RT_STRICT
86	#define Breakpoint
87	#define RT_NO_DEPRECATED_MACROS
88	#endif /* DOXYGEN_RUNNING */
89
90	/** @def RT_ARCH_X86
91	* Indicates that we're compiling for the X86 architecture.
92	*/
93
94	/** @def RT_ARCH_AMD64
95	* Indicates that we're compiling for the AMD64 architecture.
96	*/
97	#if !defined(RT_ARCH_X86) && !defined(RT_ARCH_AMD64)
98	# if defined(__amd64__) \|\| defined(__x86_64__) \|\| defined(_M_X64) \|\| defined(__AMD64__)
99	# define RT_ARCH_AMD64
100	# elif defined(__i386__) \|\| defined(_M_IX86) \|\| defined(__X86__)
101	# define RT_ARCH_X86
102	# else /* PORTME: append test for new archs. */
103	# error "Check what predefined macros your compiler uses to indicate architecture."
104	# endif
105	#elif defined(RT_ARCH_X86) && defined(RT_ARCH_AMD64) /* PORTME: append new archs. */
106	# error "Both RT_ARCH_X86 and RT_ARCH_AMD64 cannot be defined at the same time!"
107	#endif
108
109
110	/** @def __X86__
111	* Indicates that we're compiling for the X86 architecture.
112	* @deprecated
113	*/
114
115	/** @def __AMD64__
116	* Indicates that we're compiling for the AMD64 architecture.
117	* @deprecated
118	*/
119	#if !defined(__X86__) && !defined(__AMD64__)
120	# if defined(RT_ARCH_AMD64)
121	# define __AMD64__
122	# elif defined(RT_ARCH_X86)
123	# define __X86__
124	# else
125	# error "Check what predefined macros your compiler uses to indicate architecture."
126	# endif
127	#elif defined(__X86__) && defined(__AMD64__)
128	# error "Both __X86__ and __AMD64__ cannot be defined at the same time!"
129	#elif defined(__X86__) && !defined(RT_ARCH_X86)
130	# error "Both __X86__ without RT_ARCH_X86!"
131	#elif defined(__AMD64__) && !defined(RT_ARCH_AMD64)
132	# error "Both __AMD64__ without RT_ARCH_AMD64!"
133	#endif
134
135	/** @def IN_RING0
136	* Used to indicate that we're compiling code which is running
137	* in Ring-0 Host Context.
138	*/
139
140	/** @def IN_RING3
141	* Used to indicate that we're compiling code which is running
142	* in Ring-3 Host Context.
143	*/
144
145	/** @def IN_RC
146	* Used to indicate that we're compiling code which is running
147	* in the Raw-mode Context (implies R0).
148	*/
149	#if !defined(IN_RING3) && !defined(IN_RING0) && !defined(IN_RC) && !defined(IN_RC)
150	# error "You must define which context the compiled code should run in; IN_RING3, IN_RING0 or IN_RC"
151	#endif
152	#if (defined(IN_RING3) && (defined(IN_RING0) \|\| defined(IN_RC)) ) \
153	\|\| (defined(IN_RING0) && (defined(IN_RING3) \|\| defined(IN_RC)) ) \
154	\|\| (defined(IN_RC) && (defined(IN_RING3) \|\| defined(IN_RING0)) )
155	# error "Only one of the IN_RING3, IN_RING0, IN_RC defines should be defined."
156	#endif
157
158
159	/** @def ARCH_BITS
160	* Defines the bit count of the current context.
161	*/
162	#if !defined(ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
163	# if defined(RT_ARCH_AMD64)
164	# define ARCH_BITS 64
165	# else
166	# define ARCH_BITS 32
167	# endif
168	#endif
169
170	/** @def HC_ARCH_BITS
171	* Defines the host architecture bit count.
172	*/
173	#if !defined(HC_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
174	# ifndef IN_RC
175	# define HC_ARCH_BITS ARCH_BITS
176	# else
177	# define HC_ARCH_BITS 32
178	# endif
179	#endif
180
181	/** @def GC_ARCH_BITS
182	* Defines the guest architecture bit count.
183	*/
184	#if !defined(GC_ARCH_BITS) && !defined(DOXYGEN_RUNNING)
185	# ifdef VBOX_WITH_64_BITS_GUESTS
186	# define GC_ARCH_BITS 64
187	# else
188	# define GC_ARCH_BITS 32
189	# endif
190	#endif
191
192	/** @def R3_ARCH_BITS
193	* Defines the host ring-3 architecture bit count.
194	*/
195	#if !defined(R3_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
196	# ifdef IN_RING3
197	# define R3_ARCH_BITS ARCH_BITS
198	# else
199	# define R3_ARCH_BITS HC_ARCH_BITS
200	# endif
201	#endif
202
203	/** @def R0_ARCH_BITS
204	* Defines the host ring-0 architecture bit count.
205	*/
206	#if !defined(R0_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
207	# ifdef IN_RING0
208	# define R0_ARCH_BITS ARCH_BITS
209	# else
210	# define R0_ARCH_BITS HC_ARCH_BITS
211	# endif
212	#endif
213
214	/** @def GC_ARCH_BITS
215	* Defines the guest architecture bit count.
216	*/
217	#if !defined(GC_ARCH_BITS) \|\| defined(DOXYGEN_RUNNING)
218	# ifdef IN_RC
219	# define GC_ARCH_BITS ARCH_BITS
220	# else
221	# define GC_ARCH_BITS 32
222	# endif
223	#endif
224
225
226	/** @def CTXTYPE
227	* Declare a type differently in GC, R3 and R0.
228	*
229	* @param GCType The GC type.
230	* @param R3Type The R3 type.
231	* @param R0Type The R0 type.
232	* @remark For pointers used only in one context use RCPTRTYPE(), R3R0PTRTYPE(), R3PTRTYPE() or R0PTRTYPE().
233	*/
234	#ifdef IN_RC
235	# define CTXTYPE(GCType, R3Type, R0Type) GCType
236	#elif defined(IN_RING3)
237	# define CTXTYPE(GCType, R3Type, R0Type) R3Type
238	#else
239	# define CTXTYPE(GCType, R3Type, R0Type) R0Type
240	#endif
241
242	/** @def RCPTRTYPE
243	* Declare a pointer which is used in the raw mode context but appears in structure(s) used by
244	* both HC and RC. The main purpose is to make sure structures have the same
245	* size when built for different architectures.
246	*
247	* @param RCType The RC type.
248	*/
249	#define RCPTRTYPE(RCType) CTXTYPE(RCType, RTRCPTR, RTRCPTR)
250
251	/** @def R3R0PTRTYPE
252	* Declare a pointer which is used in HC, is explicitly valid in ring 3 and 0,
253	* but appears in structure(s) used by both HC and GC. The main purpose is to
254	* make sure structures have the same size when built for different architectures.
255	*
256	* @param R3R0Type The R3R0 type.
257	* @remarks This used to be called HCPTRTYPE.
258	*/
259	#define R3R0PTRTYPE(R3R0Type) CTXTYPE(RTHCPTR, R3R0Type, R3R0Type)
260
261	/** @def R3PTRTYPE
262	* Declare a pointer which is used in R3 but appears in structure(s) used by
263	* both HC and GC. The main purpose is to make sure structures have the same
264	* size when built for different architectures.
265	*
266	* @param R3Type The R3 type.
267	*/
268	#define R3PTRTYPE(R3Type) CTXTYPE(RTHCUINTPTR, R3Type, RTHCUINTPTR)
269
270	/** @def R0PTRTYPE
271	* Declare a pointer which is used in R0 but appears in structure(s) used by
272	* both HC and GC. The main purpose is to make sure structures have the same
273	* size when built for different architectures.
274	*
275	* @param R0Type The R0 type.
276	*/
277	#define R0PTRTYPE(R0Type) CTXTYPE(RTHCUINTPTR, RTHCUINTPTR, R0Type)
278
279	/** @def CTXSUFF
280	* Adds the suffix of the current context to the passed in
281	* identifier name. The suffix is HC or GC.
282	*
283	* This is macro should only be used in shared code to avoid a forest of ifdefs.
284	* @param var Identifier name.
285	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
286	*/
287	/** @def OTHERCTXSUFF
288	* Adds the suffix of the other context to the passed in
289	* identifier name. The suffix is HC or GC.
290	*
291	* This is macro should only be used in shared code to avoid a forest of ifdefs.
292	* @param var Identifier name.
293	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
294	*/
295	#ifdef IN_RC
296	# define CTXSUFF(var) var##GC
297	# define OTHERCTXSUFF(var) var##HC
298	#else
299	# define CTXSUFF(var) var##HC
300	# define OTHERCTXSUFF(var) var##GC
301	#endif
302
303	/** @def CTXALLSUFF
304	* Adds the suffix of the current context to the passed in
305	* identifier name. The suffix is R3, R0 or GC.
306	*
307	* This is macro should only be used in shared code to avoid a forest of ifdefs.
308	* @param var Identifier name.
309	* @deprecated Use CTX_SUFF. Do NOT use this for new code.
310	*/
311	#ifdef IN_RC
312	# define CTXALLSUFF(var) var##GC
313	#elif defined(IN_RING0)
314	# define CTXALLSUFF(var) var##R0
315	#else
316	# define CTXALLSUFF(var) var##R3
317	#endif
318
319	/** @def CTX_SUFF
320	* Adds the suffix of the current context to the passed in
321	* identifier name. The suffix is R3, R0 or RC.
322	*
323	* This is macro should only be used in shared code to avoid a forest of ifdefs.
324	* @param var Identifier name.
325	*
326	* @remark This will replace CTXALLSUFF and CTXSUFF before long.
327	*/
328	#ifdef IN_RC
329	# define CTX_SUFF(var) var##RC
330	#elif defined(IN_RING0)
331	# define CTX_SUFF(var) var##R0
332	#else
333	# define CTX_SUFF(var) var##R3
334	#endif
335
336	/** @def CTX_SUFF_Z
337	* Adds the suffix of the current context to the passed in
338	* identifier name, combining RC and R0 into RZ.
339	* The suffix thus is R3 or RZ.
340	*
341	* This is macro should only be used in shared code to avoid a forest of ifdefs.
342	* @param var Identifier name.
343	*
344	* @remark This will replace CTXALLSUFF and CTXSUFF before long.
345	*/
346	#ifdef IN_RING3
347	# define CTX_SUFF_Z(var) var##R3
348	#else
349	# define CTX_SUFF_Z(var) var##RZ
350	#endif
351
352
353	/** @def CTXMID
354	* Adds the current context as a middle name of an identifier name
355	* The middle name is HC or GC.
356	*
357	* This is macro should only be used in shared code to avoid a forest of ifdefs.
358	* @param first First name.
359	* @param last Surname.
360	*/
361	/** @def OTHERCTXMID
362	* Adds the other context as a middle name of an identifier name
363	* The middle name is HC or GC.
364	*
365	* This is macro should only be used in shared code to avoid a forest of ifdefs.
366	* @param first First name.
367	* @param last Surname.
368	* @deprecated use CTX_MID or CTX_MID_Z
369	*/
370	#ifdef IN_RC
371	# define CTXMID(first, last) first##GC##last
372	# define OTHERCTXMID(first, last) first##HC##last
373	#else
374	# define CTXMID(first, last) first##HC##last
375	# define OTHERCTXMID(first, last) first##GC##last
376	#endif
377
378	/** @def CTXALLMID
379	* Adds the current context as a middle name of an identifier name.
380	* The middle name is R3, R0 or GC.
381	*
382	* This is macro should only be used in shared code to avoid a forest of ifdefs.
383	* @param first First name.
384	* @param last Surname.
385	* @deprecated use CTX_MID or CTX_MID_Z
386	*/
387	#ifdef IN_RC
388	# define CTXALLMID(first, last) first##GC##last
389	#elif defined(IN_RING0)
390	# define CTXALLMID(first, last) first##R0##last
391	#else
392	# define CTXALLMID(first, last) first##R3##last
393	#endif
394
395	/** @def CTX_MID
396	* Adds the current context as a middle name of an identifier name.
397	* The middle name is R3, R0 or RC.
398	*
399	* This is macro should only be used in shared code to avoid a forest of ifdefs.
400	* @param first First name.
401	* @param last Surname.
402	*/
403	#ifdef IN_RC
404	# define CTX_MID(first, last) first##RC##last
405	#elif defined(IN_RING0)
406	# define CTX_MID(first, last) first##R0##last
407	#else
408	# define CTX_MID(first, last) first##R3##last
409	#endif
410
411	/** @def CTX_MID_Z
412	* Adds the current context as a middle name of an identifier name, combining RC
413	* and R0 into RZ.
414	* The middle name thus is either R3 or RZ.
415	*
416	* This is macro should only be used in shared code to avoid a forest of ifdefs.
417	* @param first First name.
418	* @param last Surname.
419	*/
420	#ifdef IN_RING3
421	# define CTX_MID_Z(first, last) first##R3##last
422	#else
423	# define CTX_MID_Z(first, last) first##RZ##last
424	#endif
425
426
427	/** @def R3STRING
428	* A macro which in GC and R0 will return a dummy string while in R3 it will return
429	* the parameter.
430	*
431	* This is typically used to wrap description strings in structures shared
432	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING3 mess.
433	*
434	* @param pR3String The R3 string. Only referenced in R3.
435	* @see R0STRING and GCSTRING
436	*/
437	#ifdef IN_RING3
438	# define R3STRING(pR3String) (pR3String)
439	#else
440	# define R3STRING(pR3String) ("<R3_STRING>")
441	#endif
442
443	/** @def R0STRING
444	* A macro which in GC and R3 will return a dummy string while in R0 it will return
445	* the parameter.
446	*
447	* This is typically used to wrap description strings in structures shared
448	* between R3, R0 and/or GC. The intention is to avoid the \#ifdef IN_RING0 mess.
449	*
450	* @param pR0String The R0 string. Only referenced in R0.
451	* @see R3STRING and GCSTRING
452	*/
453	#ifdef IN_RING0
454	# define R0STRING(pR0String) (pR0String)
455	#else
456	# define R0STRING(pR0String) ("<R0_STRING>")
457	#endif
458
459	/** @def RCSTRING
460	* A macro which in R3 and R0 will return a dummy string while in RC it will return
461	* the parameter.
462	*
463	* This is typically used to wrap description strings in structures shared
464	* between R3, R0 and/or RC. The intention is to avoid the \#ifdef IN_RC mess.
465	*
466	* @param pR0String The RC string. Only referenced in RC.
467	* @see R3STRING, R0STRING
468	*/
469	#ifdef IN_RC
470	# define RCSTRING(pRCString) (pRCString)
471	#else
472	# define RCSTRING(pRCString) ("<RC_STRING>")
473	#endif
474
475
476	/** @def RT_NOTHING
477	* A macro that expands to nothing.
478	* This is primarily intended as a dummy argument for macros to avoid the
479	* undefined behavior passing empty arguments to an macro (ISO C90 and C++98,
480	* gcc v4.4 warns about it).
481	*/
482	#define RT_NOTHING
483
484
485	/** @def RTCALL
486	* The standard calling convention for the Runtime interfaces.
487	*/
488	#ifdef _MSC_VER
489	# define RTCALL __cdecl
490	#elif defined(__GNUC__) && defined(IN_RING0) && !(defined(RT_OS_OS2) \|\| defined(RT_ARCH_AMD64)) /* the latter is kernel/gcc */
491	# define RTCALL __attribute__((cdecl,regparm(0)))
492	#else
493	# define RTCALL
494	#endif
495
496	/** @def RT_NO_THROW
497	* How to express that a function doesn't throw C++ exceptions
498	* and the compiler can thus save itself the bother of trying
499	* to catch any of them. Put this between the closing parenthesis
500	* and the semicolon in function prototypes (and implementation if C++).
501	*/
502	#if defined(__cplusplus) \
503	&& ( (defined(_MSC_VER) && defined(_CPPUNWIND)) \
504	\|\| (defined(__GNUC__) && defined(__EXCEPTIONS)))
505	# define RT_NO_THROW throw()
506	#else
507	# define RT_NO_THROW
508	#endif
509
510	/** @def DECLEXPORT
511	* How to declare an exported function.
512	* @param type The return type of the function declaration.
513	*/
514	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
515	# define DECLEXPORT(type) __declspec(dllexport) type
516	#elif defined(RT_USE_VISIBILITY_DEFAULT)
517	# define DECLEXPORT(type) __attribute__((visibility("default"))) type
518	#else
519	# define DECLEXPORT(type) type
520	#endif
521
522	/** @def DECLIMPORT
523	* How to declare an imported function.
524	* @param type The return type of the function declaration.
525	*/
526	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
527	# define DECLIMPORT(type) __declspec(dllimport) type
528	#else
529	# define DECLIMPORT(type) type
530	#endif
531
532	/** @def DECLHIDDEN
533	* How to declare a non-exported function or variable.
534	* @param type The return type of the function or the data type of the variable.
535	*/
536	#if defined(RT_OS_OS2) \|\| defined(RT_OS_WINDOWS) \|\| !defined(RT_USE_VISIBILITY_HIDDEN)
537	# define DECLHIDDEN(type) type
538	#else
539	# define DECLHIDDEN(type) __attribute__((visibility("hidden"))) type
540	#endif
541
542	/** @def DECLASM
543	* How to declare an internal assembly function.
544	* @param type The return type of the function declaration.
545	*/
546	#ifdef __cplusplus
547	# ifdef _MSC_VER
548	# define DECLASM(type) extern "C" type __cdecl
549	# else
550	# define DECLASM(type) extern "C" type
551	# endif
552	#else
553	# ifdef _MSC_VER
554	# define DECLASM(type) type __cdecl
555	# else
556	# define DECLASM(type) type
557	# endif
558	#endif
559
560	/** @def DECLASMTYPE
561	* How to declare an internal assembly function type.
562	* @param type The return type of the function.
563	*/
564	#ifdef _MSC_VER
565	# define DECLASMTYPE(type) type __cdecl
566	#else
567	# define DECLASMTYPE(type) type
568	#endif
569
570	/** @def DECLNORETURN
571	* How to declare a function which does not return.
572	* @note: This macro can be combined with other macros, for example
573	* @code
574	* EMR3DECL(DECLNORETURN(void)) foo(void);
575	* @endcode
576	*/
577	#ifdef _MSC_VER
578	# define DECLNORETURN(type) __declspec(noreturn) type
579	#elif defined(__GNUC__)
580	# define DECLNORETURN(type) __attribute__((noreturn)) type
581	#else
582	# define DECLNORETURN(type) type
583	#endif
584
585	/** @def DECLCALLBACK
586	* How to declare an call back function type.
587	* @param type The return type of the function declaration.
588	*/
589	#define DECLCALLBACK(type) type RTCALL
590
591	/** @def DECLCALLBACKPTR
592	* How to declare an call back function pointer.
593	* @param type The return type of the function declaration.
594	* @param name The name of the variable member.
595	*/
596	#define DECLCALLBACKPTR(type, name) type (RTCALL * name)
597
598	/** @def DECLCALLBACKMEMBER
599	* How to declare an call back function pointer member.
600	* @param type The return type of the function declaration.
601	* @param name The name of the struct/union/class member.
602	*/
603	#define DECLCALLBACKMEMBER(type, name) type (RTCALL * name)
604
605	/** @def DECLR3CALLBACKMEMBER
606	* How to declare an call back function pointer member - R3 Ptr.
607	* @param type The return type of the function declaration.
608	* @param name The name of the struct/union/class member.
609	* @param args The argument list enclosed in parentheses.
610	*/
611	#ifdef IN_RING3
612	# define DECLR3CALLBACKMEMBER(type, name, args) type (RTCALL * name) args
613	#else
614	# define DECLR3CALLBACKMEMBER(type, name, args) RTR3PTR name
615	#endif
616
617	/** @def DECLRCCALLBACKMEMBER
618	* How to declare an call back function pointer member - RC Ptr.
619	* @param type The return type of the function declaration.
620	* @param name The name of the struct/union/class member.
621	* @param args The argument list enclosed in parentheses.
622	*/
623	#ifdef IN_RC
624	# define DECLRCCALLBACKMEMBER(type, name, args) type (RTCALL * name) args
625	#else
626	# define DECLRCCALLBACKMEMBER(type, name, args) RTRCPTR name
627	#endif
628
629	/** @def DECLR0CALLBACKMEMBER
630	* How to declare an call back function pointer member - R0 Ptr.
631	* @param type The return type of the function declaration.
632	* @param name The name of the struct/union/class member.
633	* @param args The argument list enclosed in parentheses.
634	*/
635	#ifdef IN_RING0
636	# define DECLR0CALLBACKMEMBER(type, name, args) type (RTCALL * name) args
637	#else
638	# define DECLR0CALLBACKMEMBER(type, name, args) RTR0PTR name
639	#endif
640
641	/** @def DECLINLINE
642	* How to declare a function as inline.
643	* @param type The return type of the function declaration.
644	* @remarks Don't use this macro on C++ methods.
645	*/
646	#ifdef __GNUC__
647	# define DECLINLINE(type) static __inline__ type
648	#elif defined(__cplusplus)
649	# define DECLINLINE(type) inline type
650	#elif defined(_MSC_VER)
651	# define DECLINLINE(type) _inline type
652	#elif defined(__IBMC__)
653	# define DECLINLINE(type) _Inline type
654	#else
655	# define DECLINLINE(type) inline type
656	#endif
657
658
659	/** @def IN_RT_STATIC
660	* Used to indicate whether we're linking against a static IPRT
661	* or not. The IPRT symbols will be declared as hidden (if
662	* supported). Note that this define has no effect without setting
663	* IN_RT_R0, IN_RT_R3 or IN_RT_GC indicators are set first.
664	*/
665
666	/** @def IN_RT_R0
667	* Used to indicate whether we're inside the same link module as
668	* the HC Ring-0 Runtime Library.
669	*/
670	/** @def RTR0DECL(type)
671	* Runtime Library HC Ring-0 export or import declaration.
672	* @param type The return type of the function declaration.
673	*/
674	#ifdef IN_RT_R0
675	# ifdef IN_RT_STATIC
676	# define RTR0DECL(type) DECLHIDDEN(type) RTCALL
677	# else
678	# define RTR0DECL(type) DECLEXPORT(type) RTCALL
679	# endif
680	#else
681	# define RTR0DECL(type) DECLIMPORT(type) RTCALL
682	#endif
683
684	/** @def IN_RT_R3
685	* Used to indicate whether we're inside the same link module as
686	* the HC Ring-3 Runtime Library.
687	*/
688	/** @def RTR3DECL(type)
689	* Runtime Library HC Ring-3 export or import declaration.
690	* @param type The return type of the function declaration.
691	*/
692	#ifdef IN_RT_R3
693	# ifdef IN_RT_STATIC
694	# define RTR3DECL(type) DECLHIDDEN(type) RTCALL
695	# else
696	# define RTR3DECL(type) DECLEXPORT(type) RTCALL
697	# endif
698	#else
699	# define RTR3DECL(type) DECLIMPORT(type) RTCALL
700	#endif
701
702	/** @def IN_RT_GC
703	* Used to indicate whether we're inside the same link module as
704	* the GC Runtime Library.
705	*/
706	/** @def RTGCDECL(type)
707	* Runtime Library HC Ring-3 export or import declaration.
708	* @param type The return type of the function declaration.
709	*/
710	#ifdef IN_RT_GC
711	# ifdef IN_RT_STATIC
712	# define RTGCDECL(type) DECLHIDDEN(type) RTCALL
713	# else
714	# define RTGCDECL(type) DECLEXPORT(type) RTCALL
715	# endif
716	#else
717	# define RTGCDECL(type) DECLIMPORT(type) RTCALL
718	#endif
719
720	/** @def RTDECL(type)
721	* Runtime Library export or import declaration.
722	* Functions declared using this macro exists in all contexts.
723	* @param type The return type of the function declaration.
724	*/
725	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
726	# ifdef IN_RT_STATIC
727	# define RTDECL(type) DECLHIDDEN(type) RTCALL
728	# else
729	# define RTDECL(type) DECLEXPORT(type) RTCALL
730	# endif
731	#else
732	# define RTDECL(type) DECLIMPORT(type) RTCALL
733	#endif
734
735	/** @def RTDATADECL(type)
736	* Runtime Library export or import declaration.
737	* Data declared using this macro exists in all contexts.
738	* @param type The return type of the function declaration.
739	*/
740	#if defined(IN_RT_R3) \|\| defined(IN_RT_GC) \|\| defined(IN_RT_R0)
741	# ifdef IN_RT_STATIC
742	# define RTDATADECL(type) DECLHIDDEN(type)
743	# else
744	# define RTDATADECL(type) DECLEXPORT(type)
745	# endif
746	#else
747	# define RTDATADECL(type) DECLIMPORT(type)
748	#endif
749
750
751	/** @def RT_NOCRT
752	* Symbol name wrapper for the No-CRT bits.
753	*
754	* In order to coexist in the same process as other CRTs, we need to
755	* decorate the symbols such that they don't conflict the ones in the
756	* other CRTs. The result of such conflicts / duplicate symbols can
757	* confuse the dynamic loader on Unix like systems.
758	*
759	* Define RT_WITHOUT_NOCRT_WRAPPERS to drop the wrapping.
760	* Define RT_WITHOUT_NOCRT_WRAPPER_ALIASES to drop the aliases to the
761	* wrapped names.
762	*/
763	/** @def RT_NOCRT_STR
764	* Same as RT_NOCRT only it'll return a double quoted string of the result.
765	*/
766	#ifndef RT_WITHOUT_NOCRT_WRAPPERS
767	# define RT_NOCRT(name) nocrt_ ## name
768	# define RT_NOCRT_STR(name) "nocrt_" # name
769	#else
770	# define RT_NOCRT(name) name
771	# define RT_NOCRT_STR(name) #name
772	#endif
773
774
775
776	/** @def RT_LIKELY
777	* Give the compiler a hint that an expression is very likely to hold true.
778	*
779	* Some compilers support explicit branch prediction so that the CPU backend
780	* can hint the processor and also so that code blocks can be reordered such
781	* that the predicted path sees a more linear flow, thus improving cache
782	* behaviour, etc.
783	*
784	* IPRT provides the macros RT_LIKELY() and RT_UNLIKELY() as a way to utilize
785	* this compiler feature when present.
786	*
787	* A few notes about the usage:
788	*
789	* - Generally, use RT_UNLIKELY() with error condition checks (unless you
790	* have some _strong_ reason to do otherwise, in which case document it),
791	* and/or RT_LIKELY() with success condition checks, assuming you want
792	* to optimize for the success path.
793	*
794	* - Other than that, if you don't know the likelihood of a test succeeding
795	* from empirical or other 'hard' evidence, don't make predictions unless
796	* you happen to be a Dirk Gently.
797	*
798	* - These macros are meant to be used in places that get executed a lot. It
799	* is wasteful to make predictions in code that is executed rarely (e.g.
800	* at subsystem initialization time) as the basic block reordering that this
801	* affects can often generate larger code.
802	*
803	* - Note that RT_SUCCESS() and RT_FAILURE() already makes use of RT_LIKELY()
804	* and RT_UNLIKELY(). Should you wish for prediction free status checks,
805	* use the RT_SUCCESS_NP() and RT_FAILURE_NP() macros instead.
806	*
807	*
808	* @returns the boolean result of the expression.
809	* @param expr The expression that's very likely to be true.
810	* @see RT_UNLIKELY
811	*/
812	/** @def RT_UNLIKELY
813	* Give the compiler a hint that an expression is highly unlikely to hold true.
814	*
815	* See the usage instructions give in the RT_LIKELY() docs.
816	*
817	* @returns the boolean result of the expression.
818	* @param expr The expression that's very unlikely to be true.
819	* @see RT_LIKELY
820	*/
821	#if defined(__GNUC__)
822	# if __GNUC__ >= 3
823	# define RT_LIKELY(expr) __builtin_expect(!!(expr), 1)
824	# define RT_UNLIKELY(expr) __builtin_expect(!!(expr), 0)
825	# else
826	# define RT_LIKELY(expr) (expr)
827	# define RT_UNLIKELY(expr) (expr)
828	# endif
829	#else
830	# define RT_LIKELY(expr) (expr)
831	# define RT_UNLIKELY(expr) (expr)
832	#endif
833
834
835	/** @def RT_BIT
836	* Make a bitmask for one integer sized bit.
837	* @param bit Bit number.
838	*/
839	#define RT_BIT(bit) (1U << (bit))
840
841	/** @def RT_BIT_32
842	* Make a 32-bit bitmask for one bit.
843	* @param bit Bit number.
844	*/
845	#define RT_BIT_32(bit) (UINT32_C(1) << (bit))
846
847	/** @def RT_BIT_64
848	* Make a 64-bit bitmask for one bit.
849	* @param bit Bit number.
850	*/
851	#define RT_BIT_64(bit) (UINT64_C(1) << (bit))
852
853	/** @def RT_ALIGN
854	* Align macro.
855	* @param u Value to align.
856	* @param uAlignment The alignment. Power of two!
857	*
858	* @remark Be extremely careful when using this macro with type which sizeof != sizeof int.
859	* When possible use any of the other RT_ALIGN_* macros. And when that's not
860	* possible, make 101% sure that uAlignment is specified with a right sized type.
861	*
862	* Specifying an unsigned 32-bit alignment constant with a 64-bit value will give
863	* you a 32-bit return value!
864	*
865	* In short: Don't use this macro. Use RT_ALIGN_T() instead.
866	*/
867	#define RT_ALIGN(u, uAlignment) ( ((u) + ((uAlignment) - 1)) & ~((uAlignment) - 1) )
868
869	/** @def RT_ALIGN_T
870	* Align macro.
871	* @param u Value to align.
872	* @param uAlignment The alignment. Power of two!
873	* @param type Integer type to use while aligning.
874	* @remark This macro is the preferred alignment macro, it doesn't have any of the pitfalls RT_ALIGN has.
875	*/
876	#define RT_ALIGN_T(u, uAlignment, type) ( ((type)(u) + ((uAlignment) - 1)) & ~(type)((uAlignment) - 1) )
877
878	/** @def RT_ALIGN_32
879	* Align macro for a 32-bit value.
880	* @param u32 Value to align.
881	* @param uAlignment The alignment. Power of two!
882	*/
883	#define RT_ALIGN_32(u32, uAlignment) RT_ALIGN_T(u32, uAlignment, uint32_t)
884
885	/** @def RT_ALIGN_64
886	* Align macro for a 64-bit value.
887	* @param u64 Value to align.
888	* @param uAlignment The alignment. Power of two!
889	*/
890	#define RT_ALIGN_64(u64, uAlignment) RT_ALIGN_T(u64, uAlignment, uint64_t)
891
892	/** @def RT_ALIGN_Z
893	* Align macro for size_t.
894	* @param cb Value to align.
895	* @param uAlignment The alignment. Power of two!
896	*/
897	#define RT_ALIGN_Z(cb, uAlignment) RT_ALIGN_T(cb, uAlignment, size_t)
898
899	/** @def RT_ALIGN_P
900	* Align macro for pointers.
901	* @param pv Value to align.
902	* @param uAlignment The alignment. Power of two!
903	*/
904	#define RT_ALIGN_P(pv, uAlignment) RT_ALIGN_PT(pv, uAlignment, void *)
905
906	/** @def RT_ALIGN_PT
907	* Align macro for pointers with type cast.
908	* @param u Value to align.
909	* @param uAlignment The alignment. Power of two!
910	* @param CastType The type to cast the result to.
911	*/
912	#define RT_ALIGN_PT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, uintptr_t))
913
914	/** @def RT_ALIGN_R3PT
915	* Align macro for ring-3 pointers with type cast.
916	* @param u Value to align.
917	* @param uAlignment The alignment. Power of two!
918	* @param CastType The type to cast the result to.
919	*/
920	#define RT_ALIGN_R3PT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, RTR3UINTPTR))
921
922	/** @def RT_ALIGN_R0PT
923	* Align macro for ring-0 pointers with type cast.
924	* @param u Value to align.
925	* @param uAlignment The alignment. Power of two!
926	* @param CastType The type to cast the result to.
927	*/
928	#define RT_ALIGN_R0PT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, RTR0UINTPTR))
929
930	/** @def RT_ALIGN_GCPT
931	* Align macro for GC pointers with type cast.
932	* @param u Value to align.
933	* @param uAlignment The alignment. Power of two!
934	* @param CastType The type to cast the result to.
935	*/
936	#define RT_ALIGN_GCPT(u, uAlignment, CastType) ((CastType)RT_ALIGN_T(u, uAlignment, RTGCUINTPTR))
937
938
939	/** @def RT_OFFSETOF
940	* Our own special offsetof() variant, returns a signed result.
941	*
942	* This differs from the usual offsetof() in that it's not relying on builtin
943	* compiler stuff and thus can use variables in arrays the structure may
944	* contain. This is useful to determine the sizes of structures ending
945	* with a variable length field.
946	*
947	* @returns offset into the structure of the specified member. signed.
948	* @param type Structure type.
949	* @param member Member.
950	*/
951	#define RT_OFFSETOF(type, member) ( (int)(uintptr_t)&( ((type )(void )0)->member) )
952
953	/** @def RT_UOFFSETOF
954	* Our own special offsetof() variant, returns an unsigned result.
955	*
956	* This differs from the usual offsetof() in that it's not relying on builtin
957	* compiler stuff and thus can use variables in arrays the structure may
958	* contain. This is useful to determine the sizes of structures ending
959	* with a variable length field.
960	*
961	* @returns offset into the structure of the specified member. unsigned.
962	* @param type Structure type.
963	* @param member Member.
964	*/
965	#define RT_UOFFSETOF(type, member) ( (uintptr_t)&( ((type )(void )0)->member) )
966
967	/** @def RT_OFFSETOF_ADD
968	* RT_OFFSETOF with an addend.
969	*
970	* @returns offset into the structure of the specified member. signed.
971	* @param type Structure type.
972	* @param member Member.
973	* @param addend The addend to add to the offset.
974	*/
975	#define RT_OFFSETOF_ADD(type, member, addend) ( (int)RT_UOFFSETOF_ADD(type, member, addend) )
976
977	/** @def RT_UOFFSETOF_ADD
978	* RT_UOFFSETOF with an addend.
979	*
980	* @returns offset into the structure of the specified member. signed.
981	* @param type Structure type.
982	* @param member Member.
983	* @param addend The addend to add to the offset.
984	*/
985	#define RT_UOFFSETOF_ADD(type, member, addend) ( (uintptr_t)&( ((type )(void )(uintptr_t)(addend))->member) )
986
987	/** @def RT_SIZEOFMEMB
988	* Get the size of a structure member.
989	*
990	* @returns size of the structure member.
991	* @param type Structure type.
992	* @param member Member.
993	*/
994	#define RT_SIZEOFMEMB(type, member) ( sizeof(((type )(void )0)->member) )
995
996	/** @def RT_ELEMENTS
997	* Calculates the number of elements in an array.
998	* @returns Element count.
999	* @param aArray Array in question.
1000	*/
1001	#define RT_ELEMENTS(aArray) ( sizeof(aArray) / sizeof((aArray)[0]) )
1002
1003	#ifdef RT_OS_OS2
1004	/* Undefine RT_MAX since there is an unfortunate clash with the max
1005	resource type define in os2.h. */
1006	# undef RT_MAX
1007	#endif
1008
1009	/** @def RT_MAX
1010	* Finds the maximum value.
1011	* @returns The higher of the two.
1012	* @param Value1 Value 1
1013	* @param Value2 Value 2
1014	*/
1015	#define RT_MAX(Value1, Value2) ((Value1) >= (Value2) ? (Value1) : (Value2))
1016
1017	/** @def RT_MIN
1018	* Finds the minimum value.
1019	* @returns The lower of the two.
1020	* @param Value1 Value 1
1021	* @param Value2 Value 2
1022	*/
1023	#define RT_MIN(Value1, Value2) ((Value1) <= (Value2) ? (Value1) : (Value2))
1024
1025	/** @def RT_ABS
1026	* Get the absolute (non-negative) value.
1027	* @returns The absolute value of Value.
1028	* @param Value The value.
1029	*/
1030	#define RT_ABS(Value) ((Value) >= 0 ? (Value) : -(Value))
1031
1032	/** @def RT_LODWORD
1033	* Gets the low dword (=uint32_t) of something. */
1034	#define RT_LODWORD(a) ( (uint32_t)(a) )
1035
1036	/** @def RT_HIDWORD
1037	* Gets the high dword (=uint32_t) of a 64-bit of something. */
1038	#define RT_HIDWORD(a) ( (uint32_t)((a) >> 32) )
1039
1040	/** @def RT_LOWORD
1041	* Gets the low word (=uint16_t) of something. */
1042	#define RT_LOWORD(a) ((a) & 0xffff)
1043
1044	/** @def RT_HIWORD
1045	* Gets the high word (=uint16_t) of a 32-bit something. */
1046	#define RT_HIWORD(a) ((a) >> 16)
1047
1048	/** @def RT_LOBYTE
1049	* Gets the low byte of something. */
1050	#define RT_LOBYTE(a) ((a) & 0xff)
1051
1052	/** @def RT_HIBYTE
1053	* Gets the low byte of a 16-bit something. */
1054	#define RT_HIBYTE(a) ((a) >> 8)
1055
1056	/** @def RT_BYTE1
1057	* Gets first byte of something. */
1058	#define RT_BYTE1(a) ((a) & 0xff)
1059
1060	/** @def RT_BYTE2
1061	* Gets second byte of something. */
1062	#define RT_BYTE2(a) (((a) >> 8) & 0xff)
1063
1064	/** @def RT_BYTE3
1065	* Gets second byte of something. */
1066	#define RT_BYTE3(a) (((a) >> 16) & 0xff)
1067
1068	/** @def RT_BYTE4
1069	* Gets fourth byte of something. */
1070	#define RT_BYTE4(a) (((a) >> 24) & 0xff)
1071
1072
1073	/** @def RT_MAKE_U64
1074	* Constructs a uint64_t value from two uint32_t values.
1075	*/
1076	#define RT_MAKE_U64(Lo, Hi) ( (uint64_t)((uint32_t)(Hi)) << 32 \| (uint32_t)(Lo) )
1077
1078	/** @def RT_MAKE_U64_FROM_U16
1079	* Constructs a uint64_t value from four uint16_t values.
1080	*/
1081	#define RT_MAKE_U64_FROM_U16(w0, w1, w2, w3) \
1082	( (uint64_t)((uint16_t)(w3)) << 48 \
1083	\| (uint64_t)((uint16_t)(w2)) << 32 \
1084	\| (uint32_t)((uint16_t)(w1)) << 16 \
1085	\| (uint16_t)(w0) )
1086
1087	/** @def RT_MAKE_U64_FROM_U8
1088	* Constructs a uint64_t value from eight uint8_t values.
1089	*/
1090	#define RT_MAKE_U64_FROM_U8(b0, b1, b2, b3, b4, b5, b6, b7) \
1091	( (uint64_t)((uint8_t)(b7)) << 56 \
1092	\| (uint64_t)((uint8_t)(b6)) << 48 \
1093	\| (uint64_t)((uint8_t)(b5)) << 40 \
1094	\| (uint64_t)((uint8_t)(b4)) << 32 \
1095	\| (uint32_t)((uint8_t)(b3)) << 24 \
1096	\| (uint32_t)((uint8_t)(b2)) << 16 \
1097	\| (uint16_t)((uint8_t)(b1)) << 8 \
1098	\| (uint8_t)(b0) )
1099
1100	/** @def RT_MAKE_U32
1101	* Constructs a uint32_t value from two uint16_t values.
1102	*/
1103	#define RT_MAKE_U32(Lo, Hi) ( (uint32_t)((uint16_t)(Hi)) << 16 \| (uint16_t)(Lo) )
1104
1105	/** @def RT_MAKE_U32_FROM_U8
1106	* Constructs a uint32_t value from four uint8_t values.
1107	*/
1108	#define RT_MAKE_U32_FROM_U8(b0, b1, b2, b3) \
1109	( (uint32_t)((uint8_t)(b3)) << 24 \
1110	\| (uint32_t)((uint8_t)(b2)) << 16 \
1111	\| (uint16_t)((uint8_t)(b1)) << 8 \
1112	\| (uint8_t)(b0) )
1113
1114	/** @def RT_MAKE_U16
1115	* Constructs a uint32_t value from two uint16_t values.
1116	*/
1117	#define RT_MAKE_U16(Lo, Hi) ( (uint16_t)((uint8_t)(Hi)) << 8 \| (uint8_t)(Lo) )
1118
1119
1120	/** @def RT_BSWAP_U64
1121	* Reverses the byte order of an uint64_t value. */
1122	#if 0
1123	# define RT_BSWAP_U64(u64) RT_BSWAP_U64_C(u64)
1124	#elif defined(__GNUC__)
1125	/** @todo use __builtin_constant_p? */
1126	# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
1127	#else
1128	# define RT_BSWAP_U64(u64) ASMByteSwapU64(u64)
1129	#endif
1130
1131	/** @def RT_BSWAP_U32
1132	* Reverses the byte order of an uint32_t value. */
1133	#if 0
1134	# define RT_BSWAP_U32(u32) RT_BSWAP_U32_C(u32)
1135	#elif defined(__GNUC__)
1136	/** @todo use __builtin_constant_p? */
1137	# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
1138	#else
1139	# define RT_BSWAP_U32(u32) ASMByteSwapU32(u32)
1140	#endif
1141
1142	/** @def RT_BSWAP_U16
1143	* Reverses the byte order of an uint16_t value. */
1144	#if 0
1145	# define RT_BSWAP_U16(u16) RT_BSWAP_U16_C(u16)
1146	#elif defined(__GNUC__)
1147	/** @todo use __builtin_constant_p? */
1148	# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
1149	#else
1150	# define RT_BSWAP_U16(u16) ASMByteSwapU16(u16)
1151	#endif
1152
1153
1154	/** @def RT_BSWAP_U64_C
1155	* Reverses the byte order of an uint64_t constant. */
1156	#define RT_BSWAP_U64_C(u64) RT_MAKE_U64(RT_BSWAP_U32_C((u64) >> 32), RT_BSWAP_U32_C((u64) & 0xffffffff))
1157
1158	/** @def RT_BSWAP_U32_C
1159	* Reverses the byte order of an uint32_t constant. */
1160	#define RT_BSWAP_U32_C(u32) (RT_BYTE4(u32) \| (RT_BYTE3(u32) << 8) \| (RT_BYTE2(u32) << 16) \| (RT_BYTE1(u32) << 24))
1161
1162	/** @def RT_BSWAP_U16_C
1163	* Reverses the byte order of an uint16_t constant. */
1164	#define RT_BSWAP_U16_C(u16) (RT_HIBYTE(u16) \| (RT_LOBYTE(u16) << 8))
1165
1166
1167	/** @def RT_H2LE_U64
1168	* Converts an uint64_t value from host to little endian byte order. */
1169	#ifdef RT_BIG_ENDIAN
1170	# define RT_H2LE_U64(u64) RT_BSWAP_U64(u64)
1171	#else
1172	# define RT_H2LE_U64(u64) (u64)
1173	#endif
1174
1175	/** @def RT_H2LE_U64_C
1176	* Converts an uint64_t constant from host to little endian byte order. */
1177	#ifdef RT_BIG_ENDIAN
1178	# define RT_H2LE_U64_C(u64) RT_BSWAP_U64_C(u64)
1179	#else
1180	# define RT_H2LE_U64_C(u64) (u64)
1181	#endif
1182
1183	/** @def RT_H2LE_U32
1184	* Converts an uint32_t value from host to little endian byte order. */
1185	#ifdef RT_BIG_ENDIAN
1186	# define RT_H2LE_U32(u32) RT_BSWAP_U32(u32)
1187	#else
1188	# define RT_H2LE_U32(u32) (u32)
1189	#endif
1190
1191	/** @def RT_H2LE_U32_C
1192	* Converts an uint32_t constant from host to little endian byte order. */
1193	#ifdef RT_BIG_ENDIAN
1194	# define RT_H2LE_U32_C(u32) RT_BSWAP_U32_C(u32)
1195	#else
1196	# define RT_H2LE_U32_C(u32) (u32)
1197	#endif
1198
1199	/** @def RT_H2LE_U16
1200	* Converts an uint16_t value from host to little endian byte order. */
1201	#ifdef RT_BIG_ENDIAN
1202	# define RT_H2LE_U16(u16) RT_BSWAP_U16(u16)
1203	#else
1204	# define RT_H2LE_U16(u16) (u16)
1205	#endif
1206
1207	/** @def RT_H2LE_U16_C
1208	* Converts an uint16_t constant from host to little endian byte order. */
1209	#ifdef RT_BIG_ENDIAN
1210	# define RT_H2LE_U16_C(u16) RT_BSWAP_U16_C(u16)
1211	#else
1212	# define RT_H2LE_U16_C(u16) (u16)
1213	#endif
1214
1215
1216	/** @def RT_LE2H_U64
1217	* Converts an uint64_t value from little endian to host byte order. */
1218	#ifdef RT_BIG_ENDIAN
1219	# define RT_LE2H_U64(u64) RT_BSWAP_U64(u64)
1220	#else
1221	# define RT_LE2H_U64(u64) (u64)
1222	#endif
1223
1224	/** @def RT_LE2H_U64_C
1225	* Converts an uint64_t constant from little endian to host byte order. */
1226	#ifdef RT_BIG_ENDIAN
1227	# define RT_LE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
1228	#else
1229	# define RT_LE2H_U64_C(u64) (u64)
1230	#endif
1231
1232	/** @def RT_LE2H_U32
1233	* Converts an uint32_t value from little endian to host byte order. */
1234	#ifdef RT_BIG_ENDIAN
1235	# define RT_LE2H_U32(u32) RT_BSWAP_U32(u32)
1236	#else
1237	# define RT_LE2H_U32(u32) (u32)
1238	#endif
1239
1240	/** @def RT_LE2H_U32_C
1241	* Converts an uint32_t constant from little endian to host byte order. */
1242	#ifdef RT_BIG_ENDIAN
1243	# define RT_LE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
1244	#else
1245	# define RT_LE2H_U32_C(u32) (u32)
1246	#endif
1247
1248	/** @def RT_LE2H_U16
1249	* Converts an uint16_t value from little endian to host byte order. */
1250	#ifdef RT_BIG_ENDIAN
1251	# define RT_LE2H_U16(u16) RT_BSWAP_U16(u16)
1252	#else
1253	# define RT_LE2H_U16(u16) (u16)
1254	#endif
1255
1256	/** @def RT_LE2H_U16_C
1257	* Converts an uint16_t constant from little endian to host byte order. */
1258	#ifdef RT_BIG_ENDIAN
1259	# define RT_LE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
1260	#else
1261	# define RT_LE2H_U16_C(u16) (u16)
1262	#endif
1263
1264
1265	/** @def RT_H2BE_U64
1266	* Converts an uint64_t value from host to big endian byte order. */
1267	#ifdef RT_BIG_ENDIAN
1268	# define RT_H2BE_U64(u64) (u64)
1269	#else
1270	# define RT_H2BE_U64(u64) RT_BSWAP_U64(u64)
1271	#endif
1272
1273	/** @def RT_H2BE_U64_C
1274	* Converts an uint64_t constant from host to big endian byte order. */
1275	#ifdef RT_BIG_ENDIAN
1276	# define RT_H2BE_U64_C(u64) (u64)
1277	#else
1278	# define RT_H2BE_U64_C(u64) RT_BSWAP_U64_C(u64)
1279	#endif
1280
1281	/** @def RT_H2BE_U32
1282	* Converts an uint32_t value from host to big endian byte order. */
1283	#ifdef RT_BIG_ENDIAN
1284	# define RT_H2BE_U32(u32) (u32)
1285	#else
1286	# define RT_H2BE_U32(u32) RT_BSWAP_U32(u32)
1287	#endif
1288
1289	/** @def RT_H2BE_U32_C
1290	* Converts an uint32_t constant from host to big endian byte order. */
1291	#ifdef RT_BIG_ENDIAN
1292	# define RT_H2BE_U32_C(u32) (u32)
1293	#else
1294	# define RT_H2BE_U32_C(u32) RT_BSWAP_U32_C(u32)
1295	#endif
1296
1297	/** @def RT_H2BE_U16
1298	* Converts an uint16_t value from host to big endian byte order. */
1299	#ifdef RT_BIG_ENDIAN
1300	# define RT_H2BE_U16(u16) (u16)
1301	#else
1302	# define RT_H2BE_U16(u16) RT_BSWAP_U16(u16)
1303	#endif
1304
1305	/** @def RT_H2BE_U16_C
1306	* Converts an uint16_t constant from host to big endian byte order. */
1307	#ifdef RT_BIG_ENDIAN
1308	# define RT_H2BE_U16_C(u16) (u16)
1309	#else
1310	# define RT_H2BE_U16_C(u16) RT_BSWAP_U16_C(u16)
1311	#endif
1312
1313	/** @def RT_BE2H_U64
1314	* Converts an uint64_t value from big endian to host byte order. */
1315	#ifdef RT_BIG_ENDIAN
1316	# define RT_BE2H_U64(u64) (u64)
1317	#else
1318	# define RT_BE2H_U64(u64) RT_BSWAP_U64(u64)
1319	#endif
1320
1321	/** @def RT_BE2H_U64
1322	* Converts an uint64_t constant from big endian to host byte order. */
1323	#ifdef RT_BIG_ENDIAN
1324	# define RT_BE2H_U64_C(u64) (u64)
1325	#else
1326	# define RT_BE2H_U64_C(u64) RT_BSWAP_U64_C(u64)
1327	#endif
1328
1329	/** @def RT_BE2H_U32
1330	* Converts an uint32_t value from big endian to host byte order. */
1331	#ifdef RT_BIG_ENDIAN
1332	# define RT_BE2H_U32(u32) (u32)
1333	#else
1334	# define RT_BE2H_U32(u32) RT_BSWAP_U32(u32)
1335	#endif
1336
1337	/** @def RT_BE2H_U32_C
1338	* Converts an uint32_t value from big endian to host byte order. */
1339	#ifdef RT_BIG_ENDIAN
1340	# define RT_BE2H_U32_C(u32) (u32)
1341	#else
1342	# define RT_BE2H_U32_C(u32) RT_BSWAP_U32_C(u32)
1343	#endif
1344
1345	/** @def RT_BE2H_U16
1346	* Converts an uint16_t value from big endian to host byte order. */
1347	#ifdef RT_BIG_ENDIAN
1348	# define RT_BE2H_U16(u16) (u16)
1349	#else
1350	# define RT_BE2H_U16(u16) RT_BSWAP_U16(u16)
1351	#endif
1352
1353	/** @def RT_BE2H_U16_C
1354	* Converts an uint16_t constant from big endian to host byte order. */
1355	#ifdef RT_BIG_ENDIAN
1356	# define RT_BE2H_U16_C(u16) (u16)
1357	#else
1358	# define RT_BE2H_U16_C(u16) RT_BSWAP_U16_C(u16)
1359	#endif
1360
1361
1362	/** @def RT_H2N_U64
1363	* Converts an uint64_t value from host to network byte order. */
1364	#define RT_H2N_U64(u64) RT_H2BE_U64(u64)
1365
1366	/** @def RT_H2N_U64_C
1367	* Converts an uint64_t constant from host to network byte order. */
1368	#define RT_H2N_U64_C(u64) RT_H2BE_U64_C(u64)
1369
1370	/** @def RT_H2N_U32
1371	* Converts an uint32_t value from host to network byte order. */
1372	#define RT_H2N_U32(u32) RT_H2BE_U32(u32)
1373
1374	/** @def RT_H2N_U32_C
1375	* Converts an uint32_t constant from host to network byte order. */
1376	#define RT_H2N_U32_C(u32) RT_H2BE_U32_C(u32)
1377
1378	/** @def RT_H2N_U16
1379	* Converts an uint16_t value from host to network byte order. */
1380	#define RT_H2N_U16(u16) RT_H2BE_U16(u16)
1381
1382	/** @def RT_H2N_U16_C
1383	* Converts an uint16_t constant from host to network byte order. */
1384	#define RT_H2N_U16_C(u16) RT_H2BE_U16_C(u16)
1385
1386	/** @def RT_N2H_U64
1387	* Converts an uint64_t value from network to host byte order. */
1388	#define RT_N2H_U64(u64) RT_BE2H_U64(u64)
1389
1390	/** @def RT_N2H_U64_C
1391	* Converts an uint64_t constant from network to host byte order. */
1392	#define RT_N2H_U64_C(u64) RT_BE2H_U64_C(u64)
1393
1394	/** @def RT_N2H_U32
1395	* Converts an uint32_t value from network to host byte order. */
1396	#define RT_N2H_U32(u32) RT_BE2H_U32(u32)
1397
1398	/** @def RT_N2H_U32_C
1399	* Converts an uint32_t constant from network to host byte order. */
1400	#define RT_N2H_U32_C(u32) RT_BE2H_U32_C(u32)
1401
1402	/** @def RT_N2H_U16
1403	* Converts an uint16_t value from network to host byte order. */
1404	#define RT_N2H_U16(u16) RT_BE2H_U16(u16)
1405
1406	/** @def RT_N2H_U16_C
1407	* Converts an uint16_t value from network to host byte order. */
1408	#define RT_N2H_U16_C(u16) RT_BE2H_U16_C(u16)
1409
1410
1411	/*
1412	* The BSD sys/param.h + machine/param.h file is a major source of
1413	* namespace pollution. Kill off some of the worse ones unless we're
1414	* compiling kernel code.
1415	*/
1416	#if defined(RT_OS_DARWIN) \
1417	&& !defined(KERNEL) \
1418	&& !defined(RT_NO_BSD_PARAM_H_UNDEFING) \
1419	&& ( defined(_SYS_PARAM_H_) \|\| defined(_I386_PARAM_H_) )
1420	/* sys/param.h: */
1421	# undef PSWP
1422	# undef PVM
1423	# undef PINOD
1424	# undef PRIBO
1425	# undef PVFS
1426	# undef PZERO
1427	# undef PSOCK
1428	# undef PWAIT
1429	# undef PLOCK
1430	# undef PPAUSE
1431	# undef PUSER
1432	# undef PRIMASK
1433	# undef MINBUCKET
1434	# undef MAXALLOCSAVE
1435	# undef FSHIFT
1436	# undef FSCALE
1437
1438	/* i386/machine.h: */
1439	# undef ALIGN
1440	# undef ALIGNBYTES
1441	# undef DELAY
1442	# undef STATUS_WORD
1443	# undef USERMODE
1444	# undef BASEPRI
1445	# undef MSIZE
1446	# undef CLSIZE
1447	# undef CLSIZELOG2
1448	#endif
1449
1450
1451	/** @def NULL
1452	* NULL pointer.
1453	*/
1454	#ifndef NULL
1455	# ifdef __cplusplus
1456	# define NULL 0
1457	# else
1458	# define NULL ((void*)0)
1459	# endif
1460	#endif
1461
1462	/** @def NIL_OFFSET
1463	* NIL offset.
1464	* Whenever we use offsets instead of pointers to save space and relocation effort
1465	* NIL_OFFSET shall be used as the equivalent to NULL.
1466	*/
1467	#define NIL_OFFSET (~0U)
1468
1469	/** @def NOREF
1470	* Keeps the compiler from bitching about an unused parameter.
1471	*/
1472	#define NOREF(var) (void)(var)
1473
1474	/** @def Breakpoint
1475	* Emit a debug breakpoint instruction.
1476	*
1477	* Use this for instrumenting a debugging session only!
1478	* No committed code shall use Breakpoint().
1479	*/
1480	#ifdef __GNUC__
1481	# define Breakpoint() __asm__ __volatile__("int $3\n\t")
1482	#endif
1483	#ifdef _MSC_VER
1484	# define Breakpoint() __asm int 3
1485	#endif
1486	#if defined(__IBMC__) \|\| defined(__IBMCPP__)
1487	# define Breakpoint() __interrupt(3)
1488	#endif
1489	#ifndef Breakpoint
1490	# error "This compiler is not supported!"
1491	#endif
1492
1493
1494	/** Size Constants
1495	* (Of course, these are binary computer terms, not SI.)
1496	* @{
1497	*/
1498	/** 1 K (Kilo) (1 024). */
1499	#define _1K 0x00000400
1500	/** 4 K (Kilo) (4 096). */
1501	#define _4K 0x00001000
1502	/** 32 K (Kilo) (32 678). */
1503	#define _32K 0x00008000
1504	/** 64 K (Kilo) (65 536). */
1505	#define _64K 0x00010000
1506	/** 128 K (Kilo) (131 072). */
1507	#define _128K 0x00020000
1508	/** 256 K (Kilo) (262 144). */
1509	#define _256K 0x00040000
1510	/** 512 K (Kilo) (524 288). */
1511	#define _512K 0x00080000
1512	/** 1 M (Mega) (1 048 576). */
1513	#define _1M 0x00100000
1514	/** 2 M (Mega) (2 097 152). */
1515	#define _2M 0x00200000
1516	/** 4 M (Mega) (4 194 304). */
1517	#define _4M 0x00400000
1518	/** 1 G (Giga) (1 073 741 824). */
1519	#define _1G 0x40000000
1520	/** 2 G (Giga) (2 147 483 648). (32-bit) */
1521	#define _2G32 0x80000000U
1522	/** 2 G (Giga) (2 147 483 648). (64-bit) */
1523	#define _2G 0x0000000080000000LL
1524	/** 4 G (Giga) (4 294 967 296). */
1525	#define _4G 0x0000000100000000LL
1526	/** 1 T (Tera) (1 099 511 627 776). */
1527	#define _1T 0x0000010000000000LL
1528	/** 1 P (Peta) (1 125 899 906 842 624). */
1529	#define _1P 0x0004000000000000LL
1530	/** 1 E (Exa) (1 152 921 504 606 846 976). */
1531	#define _1E 0x1000000000000000LL
1532	/** 2 E (Exa) (2 305 843 009 213 693 952). */
1533	#define _2E 0x2000000000000000ULL
1534	/** @} */
1535
1536	/** @def VALID_PTR
1537	* Pointer validation macro.
1538	* @param ptr
1539	*/
1540	#if defined(RT_ARCH_AMD64)
1541	# ifdef IN_RING3
1542	# if defined(RT_OS_DARWIN) /* first 4GB is reserved for legacy kernel. */
1543	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) >= _4G \
1544	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
1545	# elif defined(RT_OS_SOLARIS) /* The kernel only used the top 2TB, but keep it simple. */
1546	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1547	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
1548	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
1549	# else
1550	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1551	&& !((uintptr_t)(ptr) & 0xffff800000000000ULL) )
1552	# endif
1553	# else /* !IN_RING3 */
1554	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U \
1555	&& ( ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0xffff800000000000ULL \
1556	\|\| ((uintptr_t)(ptr) & 0xffff800000000000ULL) == 0) )
1557	# endif /* !IN_RING3 */
1558	#elif defined(RT_ARCH_X86)
1559	# define VALID_PTR(ptr) ( (uintptr_t)(ptr) + 0x1000U >= 0x2000U )
1560	#else
1561	# error "Architecture identifier missing / not implemented."
1562	#endif
1563
1564
1565	/** @def VALID_PHYS32
1566	* 32 bits physical address validation macro.
1567	* @param Phys The RTGCPHYS address.
1568	*/
1569	#define VALID_PHYS32(Phys) ( (uint64_t)(Phys) < (uint64_t)_4G )
1570
1571	/** @def N_
1572	* The \#define N_ is used to mark a string for translation. This is usable in
1573	* any part of the code, as it is only used by the tools that create message
1574	* catalogs. This macro is a no-op as far as the compiler and code generation
1575	* is concerned.
1576	*
1577	* If you want to both mark a string for translation and translate it, use _().
1578	*/
1579	#define N_(s) (s)
1580
1581	/** @def _
1582	* The \#define _ is used to mark a string for translation and to translate it
1583	* in one step.
1584	*
1585	* If you want to only mark a string for translation, use N_().
1586	*/
1587	#define _(s) gettext(s)
1588
1589
1590	/** @def __PRETTY_FUNCTION__
1591	* With GNU C we'd like to use the builtin __PRETTY_FUNCTION__, so define that
1592	* for the other compilers.
1593	*/
1594	#if !defined(__GNUC__) && !defined(__PRETTY_FUNCTION__)
1595	# define __PRETTY_FUNCTION__ __FUNCTION__
1596	#endif
1597
1598
1599	/** @def RT_STRICT
1600	* The \#define RT_STRICT controls whether or not assertions and other runtime
1601	* checks should be compiled in or not.
1602	*
1603	* If you want assertions which are not subject to compile time options use
1604	* the AssertRelease*() flavors.
1605	*/
1606	#if !defined(RT_STRICT) && defined(DEBUG)
1607	# define RT_STRICT
1608	#endif
1609
1610	/** Source position. */
1611	#define RT_SRC_POS __FILE__, __LINE__, __PRETTY_FUNCTION__
1612
1613	/** Source position declaration. */
1614	#define RT_SRC_POS_DECL const char pszFile, unsigned iLine, const char pszFunction
1615
1616	/** Source position arguments. */
1617	#define RT_SRC_POS_ARGS pszFile, iLine, pszFunction
1618
1619	/** @} */
1620
1621
1622	/** @defgroup grp_rt_cdefs_cpp Special Macros for C++
1623	* @ingroup grp_rt_cdefs
1624	* @{
1625	*/
1626
1627	#ifdef __cplusplus
1628
1629	/** @def DECLEXPORT_CLASS
1630	* How to declare an exported class. Place this macro after the 'class'
1631	* keyword in the declaration of every class you want to export.
1632	*
1633	* @note It is necessary to use this macro even for inner classes declared
1634	* inside the already exported classes. This is a GCC specific requirement,
1635	* but it seems not to harm other compilers.
1636	*/
1637	#if defined(_MSC_VER) \|\| defined(RT_OS_OS2)
1638	# define DECLEXPORT_CLASS __declspec(dllexport)
1639	#elif defined(RT_USE_VISIBILITY_DEFAULT)
1640	# define DECLEXPORT_CLASS __attribute__((visibility("default")))
1641	#else
1642	# define DECLEXPORT_CLASS
1643	#endif
1644
1645	/** @def DECLIMPORT_CLASS
1646	* How to declare an imported class Place this macro after the 'class'
1647	* keyword in the declaration of every class you want to export.
1648	*
1649	* @note It is necessary to use this macro even for inner classes declared
1650	* inside the already exported classes. This is a GCC specific requirement,
1651	* but it seems not to harm other compilers.
1652	*/
1653	#if defined(_MSC_VER) \|\| (defined(RT_OS_OS2) && !defined(__IBMC__) && !defined(__IBMCPP__))
1654	# define DECLIMPORT_CLASS __declspec(dllimport)
1655	#elif defined(RT_USE_VISIBILITY_DEFAULT)
1656	# define DECLIMPORT_CLASS __attribute__((visibility("default")))
1657	#else
1658	# define DECLIMPORT_CLASS
1659	#endif
1660
1661	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP
1662	* Macro to work around error C2593 of the not-so-smart MSVC 7.x ambiguity
1663	* resolver. The following snippet clearly demonstrates the code causing this
1664	* error:
1665	* @code
1666	* class A
1667	* {
1668	* public:
1669	* operator bool() const { return false; }
1670	* operator int*() const { return NULL; }
1671	* };
1672	* int main()
1673	* {
1674	* A a;
1675	* if (!a);
1676	* if (a && 0);
1677	* return 0;
1678	* }
1679	* @endcode
1680	* The code itself seems pretty valid to me and GCC thinks the same.
1681	*
1682	* This macro fixes the compiler error by explicitly overloading implicit
1683	* global operators !, && and \|\| that take the given class instance as one of
1684	* their arguments.
1685	*
1686	* The best is to use this macro right after the class declaration.
1687	*
1688	* @note The macro expands to nothing for compilers other than MSVC.
1689	*
1690	* @param Cls Class to apply the workaround to
1691	*/
1692	#if defined(_MSC_VER)
1693	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls) \
1694	inline bool operator! (const Cls &that) { return !bool (that); } \
1695	inline bool operator&& (const Cls &that, bool b) { return bool (that) && b; } \
1696	inline bool operator\|\| (const Cls &that, bool b) { return bool (that) \|\| b; } \
1697	inline bool operator&& (bool b, const Cls &that) { return b && bool (that); } \
1698	inline bool operator\|\| (bool b, const Cls &that) { return b \|\| bool (that); }
1699	#else
1700	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP(Cls)
1701	#endif
1702
1703	/** @def WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL
1704	* Version of WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP for template classes.
1705	*
1706	* @param Tpl Name of the template class to apply the workaround to
1707	* @param ArgsDecl arguments of the template, as declared in \|<>\| after the
1708	* \|template\| keyword, including \|<>\|
1709	* @param Args arguments of the template, as specified in \|<>\| after the
1710	* template class name when using the, including \|<>\|
1711	*
1712	* Example:
1713	* @code
1714	* // template class declaration
1715	* template <class C>
1716	* class Foo { ... };
1717	* // applied workaround
1718	* WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL (Foo, <class C>, <C>)
1719	* @endcode
1720	*/
1721	#if defined(_MSC_VER)
1722	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args) \
1723	template ArgsDecl \
1724	inline bool operator! (const Tpl Args &that) { return !bool (that); } \
1725	template ArgsDecl \
1726	inline bool operator&& (const Tpl Args &that, bool b) { return bool (that) && b; } \
1727	template ArgsDecl \
1728	inline bool operator\|\| (const Tpl Args &that, bool b) { return bool (that) \|\| b; } \
1729	template ArgsDecl \
1730	inline bool operator&& (bool b, const Tpl Args &that) { return b && bool (that); } \
1731	template ArgsDecl \
1732	inline bool operator\|\| (bool b, const Tpl Args &that) { return b \|\| bool (that); }
1733	#else
1734	# define WORKAROUND_MSVC7_ERROR_C2593_FOR_BOOL_OP_TPL(Tpl, ArgsDecl, Args)
1735	#endif
1736
1737
1738	/** @def DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP
1739	* Declares the copy constructor and the assignment operation as inlined no-ops
1740	* (non-existent functions) for the given class. Use this macro inside the
1741	* private section if you want to effectively disable these operations for your
1742	* class.
1743	*
1744	* @param Cls class name to declare for
1745	*/
1746
1747	#define DECLARE_CLS_COPY_CTOR_ASSIGN_NOOP(Cls) \
1748	inline Cls (const Cls &); \
1749	inline Cls &operator= (const Cls &);
1750
1751
1752	/** @def DECLARE_CLS_NEW_DELETE_NOOP
1753	* Declares the new and delete operations as no-ops (non-existent functions)
1754	* for the given class. Use this macro inside the private section if you want
1755	* to effectively limit creating class instances on the stack only.
1756	*
1757	* @note The destructor of the given class must not be virtual, otherwise a
1758	* compile time error will occur. Note that this is not a drawback: having
1759	* the virtual destructor for a stack-based class is absolutely useless
1760	* (the real class of the stack-based instance is always known to the compiler
1761	* at compile time, so it will always call the correct destructor).
1762	*
1763	* @param Cls class name to declare for
1764	*/
1765	#define DECLARE_CLS_NEW_DELETE_NOOP(Cls) \
1766	inline static void *operator new (size_t); \
1767	inline static void operator delete (void *);
1768
1769	#endif /* defined(__cplusplus) */
1770
1771	/** @} */
1772
1773	#endif
1774

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

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

Download in other formats: