types.h@ 23305

Last change on this file since 23305 was 22488, checked in by vboxsync, 15 years ago
iprt/types.h,iprt/err.h: Strict type checks on what's passed to RT_SUCCESS, RT_FAILURE and their _NP variants.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 43.5 KB

Line
1	/** @file
2	* IPRT - Types.
3	*/
4
5	/*
6	* Copyright (C) 2006-2007 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_types_h
31	#define ___iprt_types_h
32
33	#include <iprt/cdefs.h>
34	#include <iprt/stdint.h>
35
36	/*
37	* Include standard C types.
38	*/
39	#ifndef IPRT_NO_CRT
40
41	# if defined(RT_OS_DARWIN) && defined(KERNEL)
42	/*
43	* Kludge for the darwin kernel:
44	* stddef.h is missing IIRC.
45	*/
46	# ifndef _PTRDIFF_T
47	# define _PTRDIFF_T
48	typedef __darwin_ptrdiff_t ptrdiff_t;
49	# endif
50	# include <sys/types.h>
51
52	# elif defined(RT_OS_FREEBSD) && defined(_KERNEL)
53	/*
54	* Kludge for the FreeBSD kernel:
55	* stddef.h and sys/types.h have slightly different offsetof definitions
56	* when compiling in kernel mode. This is just to make GCC shut up.
57	*/
58	# ifndef _STDDEF_H_
59	# undef offsetof
60	# endif
61	# include <stddef.h>
62	# ifndef _SYS_TYPES_H_
63	# undef offsetof
64	# endif
65	# include <sys/types.h>
66	# ifndef offsetof
67	# error "offsetof is not defined..."
68	# endif
69
70	# elif defined(RT_OS_FREEBSD) && HC_ARCH_BITS == 64 && defined(RT_ARCH_X86)
71	/*
72	* Kludge for compiling 32-bit code on a 64-bit FreeBSD:
73	* FreeBSD declares uint64_t and int64_t wrong (long unsigned and long int
74	* though they need to be long long unsigned and long long int). These
75	* defines conflict with our decleration in stdint.h. Adding the defines
76	* below omits the definitions in the system header.
77	*/
78	# include <stddef.h>
79	# define _UINT64_T_DECLARED
80	# define _INT64_T_DECLARED
81	# include <sys/types.h>
82
83	# elif defined(RT_OS_LINUX) && defined(__KERNEL__)
84	/*
85	* Kludge for the linux kernel:
86	* 1. sys/types.h doesn't mix with the kernel.
87	* 2. Starting with 2.6.19, linux/types.h typedefs bool and linux/stddef.h
88	* declares false and true as enum values.
89	* 3. Starting with 2.6.24, linux/types.h typedefs uintptr_t.
90	* We work around these issues here and nowhere else.
91	*/
92	# include <stddef.h>
93	# if defined(__cplusplus)
94	typedef bool _Bool;
95	# endif
96	# define bool linux_bool
97	# define true linux_true
98	# define false linux_false
99	# define uintptr_t linux_uintptr_t
100	# include <linux/autoconf.h>
101	# include <linux/types.h>
102	# include <linux/stddef.h>
103	# undef uintptr_t
104	# undef false
105	# undef true
106	# undef bool
107
108	# else
109	# include <stddef.h>
110	# include <sys/types.h>
111	# endif
112
113	/* Define any types missing from sys/types.h on windows. */
114	# ifdef _MSC_VER
115	# undef ssize_t
116	typedef intptr_t ssize_t;
117	# endif
118
119	#else /* no crt */
120	# include <iprt/nocrt/compiler/compiler.h>
121	#endif /* no crt */
122
123
124
125	/** @defgroup grp_rt_types IPRT Base Types
126	* @{
127	*/
128
129	/* define wchar_t, we don't wanna include all the wcsstuff to get this. */
130	#ifdef _MSC_VER
131	# ifndef _WCHAR_T_DEFINED
132	typedef unsigned short wchar_t;
133	# define _WCHAR_T_DEFINED
134	# endif
135	#endif
136	#ifdef __GNUC__
137	/** @todo wchar_t on GNUC */
138	#endif
139
140	/*
141	* C doesn't have bool.
142	*/
143	#ifndef __cplusplus
144	# if defined(__GNUC__)
145	# if defined(RT_OS_LINUX) && __GNUC__ < 3
146	typedef uint8_t bool;
147	# else
148	# if defined(RT_OS_DARWIN) && defined(_STDBOOL_H)
149	# undef bool
150	# endif
151	typedef _Bool bool;
152	# endif
153	# else
154	typedef unsigned char bool;
155	# endif
156	# ifndef true
157	# define true (1)
158	# endif
159	# ifndef false
160	# define false (0)
161	# endif
162	#endif
163
164	/**
165	* 128-bit unsigned integer.
166	*/
167	#if defined(__GNUC__) && defined(RT_ARCH_AMD64)
168	typedef __uint128_t uint128_t;
169	#else
170	typedef struct uint128_s
171	{
172	uint64_t Lo;
173	uint64_t Hi;
174	} uint128_t;
175	#endif
176
177
178	/**
179	* 128-bit signed integer.
180	*/
181	#if defined(__GNUC__) && defined(RT_ARCH_AMD64)
182	typedef __int128_t int128_t;
183	#else
184	typedef struct int128_s
185	{
186	uint64_t lo;
187	int64_t hi;
188	} int128_t;
189	#endif
190
191
192	/**
193	* 16-bit unsigned integer union.
194	*/
195	typedef union RTUINT16U
196	{
197	/** natural view. */
198	uint16_t u;
199
200	/** 16-bit view. */
201	uint16_t au16[1];
202	/** 8-bit view. */
203	uint8_t au8[4];
204	/** 16-bit hi/lo view. */
205	struct
206	{
207	uint16_t Lo;
208	uint16_t Hi;
209	} s;
210	} RTUINT16U;
211	/** Pointer to a 16-bit unsigned integer union. */
212	typedef RTUINT16U *PRTUINT16U;
213	/** Pointer to a const 32-bit unsigned integer union. */
214	typedef const RTUINT16U *PCRTUINT16U;
215
216
217	/**
218	* 32-bit unsigned integer union.
219	*/
220	typedef union RTUINT32U
221	{
222	/** natural view. */
223	uint32_t u;
224	/** Hi/Low view. */
225	struct
226	{
227	uint16_t Lo;
228	uint16_t Hi;
229	} s;
230	/** Word view. */
231	struct
232	{
233	uint16_t w0;
234	uint16_t w1;
235	} Words;
236
237	/** 32-bit view. */
238	uint32_t au32[1];
239	/** 16-bit view. */
240	uint16_t au16[2];
241	/** 8-bit view. */
242	uint8_t au8[4];
243	} RTUINT32U;
244	/** Pointer to a 32-bit unsigned integer union. */
245	typedef RTUINT32U *PRTUINT32U;
246	/** Pointer to a const 32-bit unsigned integer union. */
247	typedef const RTUINT32U *PCRTUINT32U;
248
249
250	/**
251	* 64-bit unsigned integer union.
252	*/
253	typedef union RTUINT64U
254	{
255	/** Natural view. */
256	uint64_t u;
257	/** Hi/Low view. */
258	struct
259	{
260	uint32_t Lo;
261	uint32_t Hi;
262	} s;
263	/** Double-Word view. */
264	struct
265	{
266	uint32_t dw0;
267	uint32_t dw1;
268	} DWords;
269	/** Word view. */
270	struct
271	{
272	uint16_t w0;
273	uint16_t w1;
274	uint16_t w2;
275	uint16_t w3;
276	} Words;
277
278	/** 64-bit view. */
279	uint64_t au64[1];
280	/** 32-bit view. */
281	uint32_t au32[2];
282	/** 16-bit view. */
283	uint16_t au16[4];
284	/** 8-bit view. */
285	uint8_t au8[8];
286	} RTUINT64U;
287	/** Pointer to a 64-bit unsigned integer union. */
288	typedef RTUINT64U *PRTUINT64U;
289	/** Pointer to a const 64-bit unsigned integer union. */
290	typedef const RTUINT64U *PCRTUINT64U;
291
292
293	/**
294	* 128-bit unsigned integer union.
295	*/
296	typedef union RTUINT128U
297	{
298	/** Natural view.
299	* WARNING! This member depends on the compiler supporting 128-bit stuff. */
300	uint128_t u;
301	/** Hi/Low view. */
302	struct
303	{
304	uint64_t Lo;
305	uint64_t Hi;
306	} s;
307	/** Quad-Word view. */
308	struct
309	{
310	uint64_t qw0;
311	uint64_t qw1;
312	} QWords;
313	/** Double-Word view. */
314	struct
315	{
316	uint32_t dw0;
317	uint32_t dw1;
318	uint32_t dw2;
319	uint32_t dw3;
320	} DWords;
321	/** Word view. */
322	struct
323	{
324	uint16_t w0;
325	uint16_t w1;
326	uint16_t w2;
327	uint16_t w3;
328	uint16_t w4;
329	uint16_t w5;
330	uint16_t w6;
331	uint16_t w7;
332	} Words;
333
334	/** 64-bit view. */
335	uint64_t au64[2];
336	/** 32-bit view. */
337	uint32_t au32[4];
338	/** 16-bit view. */
339	uint16_t au16[8];
340	/** 8-bit view. */
341	uint8_t au8[16];
342	} RTUINT128U;
343	/** Pointer to a 64-bit unsigned integer union. */
344	typedef RTUINT128U *PRTUINT128U;
345	/** Pointer to a const 64-bit unsigned integer union. */
346	typedef const RTUINT128U *PCRTUINT128U;
347
348
349	/** Generic function type.
350	* @see PFNRT
351	*/
352	typedef DECLCALLBACK(void) FNRT(void);
353
354	/** Generic function pointer.
355	* With -pedantic, gcc-4 complains when casting a function to a data object, for example
356	*
357	* @code
358	* void foo(void)
359	* {
360	* }
361	*
362	* void bar = (void )foo;
363	* @endcode
364	*
365	* The compiler would warn with "ISO C++ forbids casting between pointer-to-function and
366	* pointer-to-object". The purpose of this warning is not to bother the programmer but to
367	* point out that he is probably doing something dangerous, assigning a pointer to executable
368	* code to a data object.
369	*/
370	typedef FNRT *PFNRT;
371
372
373	/** @defgroup grp_rt_types_both Common Guest and Host Context Basic Types
374	* @ingroup grp_rt_types
375	* @{
376	*/
377
378	/** Signed integer which can contain both GC and HC pointers. */
379	#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
380	typedef int32_t RTINTPTR;
381	#elif (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
382	typedef int64_t RTINTPTR;
383	#else
384	# error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
385	#endif
386	/** Pointer to signed integer which can contain both GC and HC pointers. */
387	typedef RTINTPTR *PRTINTPTR;
388	/** Pointer const to signed integer which can contain both GC and HC pointers. */
389	typedef const RTINTPTR *PCRTINTPTR;
390
391	/** Unsigned integer which can contain both GC and HC pointers. */
392	#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
393	typedef uint32_t RTUINTPTR;
394	#elif (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
395	typedef uint64_t RTUINTPTR;
396	#else
397	# error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
398	#endif
399	/** Pointer to unsigned integer which can contain both GC and HC pointers. */
400	typedef RTUINTPTR *PRTUINTPTR;
401	/** Pointer const to unsigned integer which can contain both GC and HC pointers. */
402	typedef const RTUINTPTR *PCRTUINTPTR;
403	/** The maximum value the RTUINTPTR type can hold. */
404	#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
405	# define RTUINTPTR_MAX UINT32_MAX
406	#elif (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
407	# define RTUINTPTR_MAX UINT64_MAX
408	#else
409	# error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
410	#endif
411
412	/** Signed integer. */
413	typedef int32_t RTINT;
414	/** Pointer to signed integer. */
415	typedef RTINT *PRTINT;
416	/** Pointer to const signed integer. */
417	typedef const RTINT *PCRTINT;
418
419	/** Unsigned integer. */
420	typedef uint32_t RTUINT;
421	/** Pointer to unsigned integer. */
422	typedef RTUINT *PRTUINT;
423	/** Pointer to const unsigned integer. */
424	typedef const RTUINT *PCRTUINT;
425
426	/** A file offset / size (off_t). */
427	typedef int64_t RTFOFF;
428	/** Pointer to a file offset / size. */
429	typedef RTFOFF *PRTFOFF;
430	/** The max value for RTFOFF. */
431	#define RTFOFF_MAX INT64_MAX
432	/** The min value for RTFOFF. */
433	#define RTFOFF_MIN INT64_MIN
434
435	/** File mode (see iprt/fs.h). */
436	typedef uint32_t RTFMODE;
437	/** Pointer to file mode. */
438	typedef RTFMODE *PRTFMODE;
439
440	/** Device unix number. */
441	typedef uint32_t RTDEV;
442	/** Pointer to a device unix number. */
443	typedef RTDEV *PRTDEV;
444
445	/** i-node number. */
446	typedef uint64_t RTINODE;
447	/** Pointer to a i-node number. */
448	typedef RTINODE *PRTINODE;
449
450	/** User id. */
451	typedef uint32_t RTUID;
452	/** Pointer to a user id. */
453	typedef RTUID *PRTUID;
454	/** NIL user id.
455	* @todo check this for portability! */
456	#define NIL_RTUID (~(RTUID)0);
457
458	/** Group id. */
459	typedef uint32_t RTGID;
460	/** Pointer to a group id. */
461	typedef RTGID *PRTGID;
462	/** NIL group id.
463	* @todo check this for portability! */
464	#define NIL_RTGID (~(RTGID)0);
465
466	/** I/O Port. */
467	typedef uint16_t RTIOPORT;
468	/** Pointer to I/O Port. */
469	typedef RTIOPORT *PRTIOPORT;
470	/** Pointer to const I/O Port. */
471	typedef const RTIOPORT *PCRTIOPORT;
472
473	/** Selector. */
474	typedef uint16_t RTSEL;
475	/** Pointer to selector. */
476	typedef RTSEL *PRTSEL;
477	/** Pointer to const selector. */
478	typedef const RTSEL *PCRTSEL;
479	/** Max selector value. */
480	#define RTSEL_MAX UINT16_MAX
481
482	/** Far 16-bit pointer. */
483	#pragma pack(1)
484	typedef struct RTFAR16
485	{
486	uint16_t off;
487	RTSEL sel;
488	} RTFAR16;
489	#pragma pack()
490	/** Pointer to Far 16-bit pointer. */
491	typedef RTFAR16 *PRTFAR16;
492	/** Pointer to const Far 16-bit pointer. */
493	typedef const RTFAR16 *PCRTFAR16;
494
495	/** Far 32-bit pointer. */
496	#pragma pack(1)
497	typedef struct RTFAR32
498	{
499	uint32_t off;
500	RTSEL sel;
501	} RTFAR32;
502	#pragma pack()
503	/** Pointer to Far 32-bit pointer. */
504	typedef RTFAR32 *PRTFAR32;
505	/** Pointer to const Far 32-bit pointer. */
506	typedef const RTFAR32 *PCRTFAR32;
507
508	/** Far 64-bit pointer. */
509	#pragma pack(1)
510	typedef struct RTFAR64
511	{
512	uint64_t off;
513	RTSEL sel;
514	} RTFAR64;
515	#pragma pack()
516	/** Pointer to Far 64-bit pointer. */
517	typedef RTFAR64 *PRTFAR64;
518	/** Pointer to const Far 64-bit pointer. */
519	typedef const RTFAR64 *PCRTFAR64;
520
521	/** @} */
522
523
524	/** @defgroup grp_rt_types_hc Host Context Basic Types
525	* @ingroup grp_rt_types
526	* @{
527	*/
528
529	/** HC Natural signed integer.
530	* @deprecated silly type. */
531	typedef int32_t RTHCINT;
532	/** Pointer to HC Natural signed integer.
533	* @deprecated silly type. */
534	typedef RTHCINT *PRTHCINT;
535	/** Pointer to const HC Natural signed integer.
536	* @deprecated silly type. */
537	typedef const RTHCINT *PCRTHCINT;
538
539	/** HC Natural unsigned integer.
540	* @deprecated silly type. */
541	typedef uint32_t RTHCUINT;
542	/** Pointer to HC Natural unsigned integer.
543	* @deprecated silly type. */
544	typedef RTHCUINT *PRTHCUINT;
545	/** Pointer to const HC Natural unsigned integer.
546	* @deprecated silly type. */
547	typedef const RTHCUINT *PCRTHCUINT;
548
549
550	/** Signed integer which can contain a HC pointer. */
551	#if HC_ARCH_BITS == 32
552	typedef int32_t RTHCINTPTR;
553	#elif HC_ARCH_BITS == 64
554	typedef int64_t RTHCINTPTR;
555	#else
556	# error Unsupported HC_ARCH_BITS value.
557	#endif
558	/** Pointer to signed integer which can contain a HC pointer. */
559	typedef RTHCINTPTR *PRTHCINTPTR;
560	/** Pointer to const signed integer which can contain a HC pointer. */
561	typedef const RTHCINTPTR *PCRTHCINTPTR;
562	/** Max RTHCINTPTR value. */
563	#if HC_ARCH_BITS == 32
564	# define RTHCINTPTR_MAX INT32_MAX
565	#else
566	# define RTHCINTPTR_MAX INT64_MAX
567	#endif
568	/** Min RTHCINTPTR value. */
569	#if HC_ARCH_BITS == 32
570	# define RTHCINTPTR_MIN INT32_MIN
571	#else
572	# define RTHCINTPTR_MIN INT64_MIN
573	#endif
574
575	/** Signed integer which can contain a HC ring-3 pointer. */
576	#if R3_ARCH_BITS == 32
577	typedef int32_t RTR3INTPTR;
578	#elif R3_ARCH_BITS == 64
579	typedef int64_t RTR3INTPTR;
580	#else
581	# error Unsupported R3_ARCH_BITS value.
582	#endif
583	/** Pointer to signed integer which can contain a HC ring-3 pointer. */
584	typedef RTR3INTPTR *PRTR3INTPTR;
585	/** Pointer to const signed integer which can contain a HC ring-3 pointer. */
586	typedef const RTR3INTPTR *PCRTR3INTPTR;
587	/** Max RTR3INTPTR value. */
588	#if R3_ARCH_BITS == 32
589	# define RTR3INTPTR_MAX INT32_MAX
590	#else
591	# define RTR3INTPTR_MAX INT64_MAX
592	#endif
593	/** Min RTR3INTPTR value. */
594	#if R3_ARCH_BITS == 32
595	# define RTR3INTPTR_MIN INT32_MIN
596	#else
597	# define RTR3INTPTR_MIN INT64_MIN
598	#endif
599
600	/** Signed integer which can contain a HC ring-0 pointer. */
601	#if R0_ARCH_BITS == 32
602	typedef int32_t RTR0INTPTR;
603	#elif R0_ARCH_BITS == 64
604	typedef int64_t RTR0INTPTR;
605	#else
606	# error Unsupported R0_ARCH_BITS value.
607	#endif
608	/** Pointer to signed integer which can contain a HC ring-0 pointer. */
609	typedef RTR0INTPTR *PRTR0INTPTR;
610	/** Pointer to const signed integer which can contain a HC ring-0 pointer. */
611	typedef const RTR0INTPTR *PCRTR0INTPTR;
612	/** Max RTR0INTPTR value. */
613	#if R0_ARCH_BITS == 32
614	# define RTR0INTPTR_MAX INT32_MAX
615	#else
616	# define RTR0INTPTR_MAX INT64_MAX
617	#endif
618	/** Min RTHCINTPTR value. */
619	#if R0_ARCH_BITS == 32
620	# define RTR0INTPTR_MIN INT32_MIN
621	#else
622	# define RTR0INTPTR_MIN INT64_MIN
623	#endif
624
625
626	/** Unsigned integer which can contain a HC pointer. */
627	#if HC_ARCH_BITS == 32
628	typedef uint32_t RTHCUINTPTR;
629	#elif HC_ARCH_BITS == 64
630	typedef uint64_t RTHCUINTPTR;
631	#else
632	# error Unsupported HC_ARCH_BITS value.
633	#endif
634	/** Pointer to unsigned integer which can contain a HC pointer. */
635	typedef RTHCUINTPTR *PRTHCUINTPTR;
636	/** Pointer to unsigned integer which can contain a HC pointer. */
637	typedef const RTHCUINTPTR *PCRTHCUINTPTR;
638	/** Max RTHCUINTTPR value. */
639	#if HC_ARCH_BITS == 32
640	# define RTHCUINTPTR_MAX UINT32_MAX
641	#else
642	# define RTHCUINTPTR_MAX UINT64_MAX
643	#endif
644
645	/** Unsigned integer which can contain a HC ring-3 pointer. */
646	#if R3_ARCH_BITS == 32
647	typedef uint32_t RTR3UINTPTR;
648	#elif R3_ARCH_BITS == 64
649	typedef uint64_t RTR3UINTPTR;
650	#else
651	# error Unsupported R3_ARCH_BITS value.
652	#endif
653	/** Pointer to unsigned integer which can contain a HC ring-3 pointer. */
654	typedef RTR3UINTPTR *PRTR3UINTPTR;
655	/** Pointer to unsigned integer which can contain a HC ring-3 pointer. */
656	typedef const RTR3UINTPTR *PCRTR3UINTPTR;
657	/** Max RTHCUINTTPR value. */
658	#if R3_ARCH_BITS == 32
659	# define RTR3UINTPTR_MAX UINT32_MAX
660	#else
661	# define RTR3UINTPTR_MAX UINT64_MAX
662	#endif
663
664	/** Unsigned integer which can contain a HC ring-0 pointer. */
665	#if R0_ARCH_BITS == 32
666	typedef uint32_t RTR0UINTPTR;
667	#elif R0_ARCH_BITS == 64
668	typedef uint64_t RTR0UINTPTR;
669	#else
670	# error Unsupported R0_ARCH_BITS value.
671	#endif
672	/** Pointer to unsigned integer which can contain a HC ring-0 pointer. */
673	typedef RTR0UINTPTR *PRTR0UINTPTR;
674	/** Pointer to unsigned integer which can contain a HC ring-0 pointer. */
675	typedef const RTR0UINTPTR *PCRTR0UINTPTR;
676	/** Max RTR0UINTTPR value. */
677	#if HC_ARCH_BITS == 32
678	# define RTR0UINTPTR_MAX UINT32_MAX
679	#else
680	# define RTR0UINTPTR_MAX UINT64_MAX
681	#endif
682
683
684	/** Host Physical Memory Address. */
685	typedef uint64_t RTHCPHYS;
686	/** Pointer to Host Physical Memory Address. */
687	typedef RTHCPHYS *PRTHCPHYS;
688	/** Pointer to const Host Physical Memory Address. */
689	typedef const RTHCPHYS *PCRTHCPHYS;
690	/** @def NIL_RTHCPHYS
691	* NIL HC Physical Address.
692	* NIL_RTHCPHYS is used to signal an invalid physical address, similar
693	* to the NULL pointer.
694	*/
695	#define NIL_RTHCPHYS (~(RTHCPHYS)0)
696	/** Max RTHCPHYS value. */
697	#define RTHCPHYS_MAX UINT64_MAX
698
699
700	/** HC pointer. */
701	#ifndef IN_RC
702	typedef void * RTHCPTR;
703	#else
704	typedef RTHCUINTPTR RTHCPTR;
705	#endif
706	/** Pointer to HC pointer. */
707	typedef RTHCPTR *PRTHCPTR;
708	/** Pointer to const HC pointer. */
709	typedef const RTHCPTR *PCRTHCPTR;
710	/** @def NIL_RTHCPTR
711	* NIL HC pointer.
712	*/
713	#define NIL_RTHCPTR ((RTHCPTR)0)
714	/** Max RTHCPTR value. */
715	#define RTHCPTR_MAX ((RTHCPTR)RTHCUINTPTR_MAX)
716
717
718	/** HC ring-3 pointer. */
719	#ifdef IN_RING3
720	typedef void * RTR3PTR;
721	#else
722	typedef RTR3UINTPTR RTR3PTR;
723	#endif
724	/** Pointer to HC ring-3 pointer. */
725	typedef RTR3PTR *PRTR3PTR;
726	/** Pointer to const HC ring-3 pointer. */
727	typedef const RTR3PTR *PCRTR3PTR;
728	/** @def NIL_RTR3PTR
729	* NIL HC ring-3 pointer.
730	*/
731	#define NIL_RTR3PTR ((RTR3PTR)0)
732	/** Max RTR3PTR value. */
733	#define RTR3PTR_MAX ((RTR3PTR)RTR3UINTPTR_MAX)
734
735	/** HC ring-0 pointer. */
736	#ifdef IN_RING0
737	typedef void * RTR0PTR;
738	#else
739	typedef RTR0UINTPTR RTR0PTR;
740	#endif
741	/** Pointer to HC ring-0 pointer. */
742	typedef RTR0PTR *PRTR0PTR;
743	/** Pointer to const HC ring-0 pointer. */
744	typedef const RTR0PTR *PCRTR0PTR;
745	/** @def NIL_RTR0PTR
746	* NIL HC ring-0 pointer.
747	*/
748	#define NIL_RTR0PTR ((RTR0PTR)0)
749	/** Max RTR3PTR value. */
750	#define RTR0PTR_MAX ((RTR0PTR)RTR0UINTPTR_MAX)
751
752
753	/** Unsigned integer register in the host context. */
754	#if HC_ARCH_BITS == 32
755	typedef uint32_t RTHCUINTREG;
756	#elif HC_ARCH_BITS == 64
757	typedef uint64_t RTHCUINTREG;
758	#else
759	# error "Unsupported HC_ARCH_BITS!"
760	#endif
761	/** Pointer to an unsigned integer register in the host context. */
762	typedef RTHCUINTREG *PRTHCUINTREG;
763	/** Pointer to a const unsigned integer register in the host context. */
764	typedef const RTHCUINTREG *PCRTHCUINTREG;
765
766	/** Unsigned integer register in the host ring-3 context. */
767	#if R3_ARCH_BITS == 32
768	typedef uint32_t RTR3UINTREG;
769	#elif R3_ARCH_BITS == 64
770	typedef uint64_t RTR3UINTREG;
771	#else
772	# error "Unsupported R3_ARCH_BITS!"
773	#endif
774	/** Pointer to an unsigned integer register in the host ring-3 context. */
775	typedef RTR3UINTREG *PRTR3UINTREG;
776	/** Pointer to a const unsigned integer register in the host ring-3 context. */
777	typedef const RTR3UINTREG *PCRTR3UINTREG;
778
779	/** Unsigned integer register in the host ring-3 context. */
780	#if R0_ARCH_BITS == 32
781	typedef uint32_t RTR0UINTREG;
782	#elif R0_ARCH_BITS == 64
783	typedef uint64_t RTR0UINTREG;
784	#else
785	# error "Unsupported R3_ARCH_BITS!"
786	#endif
787	/** Pointer to an unsigned integer register in the host ring-3 context. */
788	typedef RTR0UINTREG *PRTR0UINTREG;
789	/** Pointer to a const unsigned integer register in the host ring-3 context. */
790	typedef const RTR0UINTREG *PCRTR0UINTREG;
791
792	/** @} */
793
794
795	/** @defgroup grp_rt_types_gc Guest Context Basic Types
796	* @ingroup grp_rt_types
797	* @{
798	*/
799
800	/** Natural signed integer in the GC.
801	* @deprecated silly type. */
802	#if GC_ARCH_BITS == 32
803	typedef int32_t RTGCINT;
804	#elif GC_ARCH_BITS == 64 /** @todo this isn't right, natural int is 32-bit, see RTHCINT. */
805	typedef int64_t RTGCINT;
806	#endif
807	/** Pointer to natural signed integer in GC.
808	* @deprecated silly type. */
809	typedef RTGCINT *PRTGCINT;
810	/** Pointer to const natural signed integer in GC.
811	* @deprecated silly type. */
812	typedef const RTGCINT *PCRTGCINT;
813
814	/** Natural unsigned integer in the GC.
815	* @deprecated silly type. */
816	#if GC_ARCH_BITS == 32
817	typedef uint32_t RTGCUINT;
818	#elif GC_ARCH_BITS == 64 /** @todo this isn't right, natural int is 32-bit, see RTHCUINT. */
819	typedef uint64_t RTGCUINT;
820	#endif
821	/** Pointer to natural unsigned integer in GC.
822	* @deprecated silly type. */
823	typedef RTGCUINT *PRTGCUINT;
824	/** Pointer to const natural unsigned integer in GC.
825	* @deprecated silly type. */
826	typedef const RTGCUINT *PCRTGCUINT;
827
828	/** Signed integer which can contain a GC pointer. */
829	#if GC_ARCH_BITS == 32
830	typedef int32_t RTGCINTPTR;
831	#elif GC_ARCH_BITS == 64
832	typedef int64_t RTGCINTPTR;
833	#endif
834	/** Pointer to signed integer which can contain a GC pointer. */
835	typedef RTGCINTPTR *PRTGCINTPTR;
836	/** Pointer to const signed integer which can contain a GC pointer. */
837	typedef const RTGCINTPTR *PCRTGCINTPTR;
838
839	/** Unsigned integer which can contain a GC pointer. */
840	#if GC_ARCH_BITS == 32
841	typedef uint32_t RTGCUINTPTR;
842	#elif GC_ARCH_BITS == 64
843	typedef uint64_t RTGCUINTPTR;
844	#else
845	# error Unsupported GC_ARCH_BITS value.
846	#endif
847	/** Pointer to unsigned integer which can contain a GC pointer. */
848	typedef RTGCUINTPTR *PRTGCUINTPTR;
849	/** Pointer to unsigned integer which can contain a GC pointer. */
850	typedef const RTGCUINTPTR *PCRTGCUINTPTR;
851
852	/** Unsigned integer which can contain a 32 bits GC pointer. */
853	typedef uint32_t RTGCUINTPTR32;
854	/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
855	typedef RTGCUINTPTR32 *PRTGCUINTPTR32;
856	/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
857	typedef const RTGCUINTPTR32 *PCRTGCUINTPTR32;
858
859	/** Unsigned integer which can contain a 64 bits GC pointer. */
860	typedef uint64_t RTGCUINTPTR64;
861	/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
862	typedef RTGCUINTPTR64 *PRTGCUINTPTR64;
863	/** Pointer to unsigned integer which can contain a 32 bits GC pointer. */
864	typedef const RTGCUINTPTR64 *PCRTGCUINTPTR64;
865
866	/** Guest Physical Memory Address.*/
867	typedef uint64_t RTGCPHYS;
868	/** Pointer to Guest Physical Memory Address. */
869	typedef RTGCPHYS *PRTGCPHYS;
870	/** Pointer to const Guest Physical Memory Address. */
871	typedef const RTGCPHYS *PCRTGCPHYS;
872	/** @def NIL_RTGCPHYS
873	* NIL GC Physical Address.
874	* NIL_RTGCPHYS is used to signal an invalid physical address, similar
875	* to the NULL pointer. Note that this value may actually be valid in
876	* some contexts.
877	*/
878	#define NIL_RTGCPHYS (~(RTGCPHYS)0U)
879	/** Max guest physical memory address value. */
880	#define RTGCPHYS_MAX UINT64_MAX
881
882
883	/** Guest Physical Memory Address; limited to 32 bits.*/
884	typedef uint32_t RTGCPHYS32;
885	/** Pointer to Guest Physical Memory Address. */
886	typedef RTGCPHYS32 *PRTGCPHYS32;
887	/** Pointer to const Guest Physical Memory Address. */
888	typedef const RTGCPHYS32 *PCRTGCPHYS32;
889	/** @def NIL_RTGCPHYS32
890	* NIL GC Physical Address.
891	* NIL_RTGCPHYS32 is used to signal an invalid physical address, similar
892	* to the NULL pointer. Note that this value may actually be valid in
893	* some contexts.
894	*/
895	#define NIL_RTGCPHYS32 (~(RTGCPHYS32)0)
896
897
898	/** Guest Physical Memory Address; limited to 64 bits.*/
899	typedef uint64_t RTGCPHYS64;
900	/** Pointer to Guest Physical Memory Address. */
901	typedef RTGCPHYS64 *PRTGCPHYS64;
902	/** Pointer to const Guest Physical Memory Address. */
903	typedef const RTGCPHYS64 *PCRTGCPHYS64;
904	/** @def NIL_RTGCPHYS64
905	* NIL GC Physical Address.
906	* NIL_RTGCPHYS64 is used to signal an invalid physical address, similar
907	* to the NULL pointer. Note that this value may actually be valid in
908	* some contexts.
909	*/
910	#define NIL_RTGCPHYS64 (~(RTGCPHYS64)0)
911
912	/** Guest context pointer, 32 bits.
913	* Keep in mind that this type is an unsigned integer in
914	* HC and void pointer in GC.
915	*/
916	typedef RTGCUINTPTR32 RTGCPTR32;
917	/** Pointer to a guest context pointer. */
918	typedef RTGCPTR32 *PRTGCPTR32;
919	/** Pointer to a const guest context pointer. */
920	typedef const RTGCPTR32 *PCRTGCPTR32;
921	/** @def NIL_RTGCPTR32
922	* NIL GC pointer.
923	*/
924	#define NIL_RTGCPTR32 ((RTGCPTR32)0)
925
926	/** Guest context pointer, 64 bits.
927	*/
928	typedef RTGCUINTPTR64 RTGCPTR64;
929	/** Pointer to a guest context pointer. */
930	typedef RTGCPTR64 *PRTGCPTR64;
931	/** Pointer to a const guest context pointer. */
932	typedef const RTGCPTR64 *PCRTGCPTR64;
933	/** @def NIL_RTGCPTR64
934	* NIL GC pointer.
935	*/
936	#define NIL_RTGCPTR64 ((RTGCPTR64)0)
937
938	/** Guest context pointer.
939	* Keep in mind that this type is an unsigned integer in
940	* HC and void pointer in GC.
941	*/
942	#if GC_ARCH_BITS == 64
943	typedef RTGCPTR64 RTGCPTR;
944	/** Pointer to a guest context pointer. */
945	typedef PRTGCPTR64 PRTGCPTR;
946	/** Pointer to a const guest context pointer. */
947	typedef PCRTGCPTR64 PCRTGCPTR;
948	/** @def NIL_RTGCPTR
949	* NIL GC pointer.
950	*/
951	# define NIL_RTGCPTR NIL_RTGCPTR64
952	/** Max RTGCPTR value. */
953	# define RTGCPTR_MAX UINT64_MAX
954	#elif GC_ARCH_BITS == 32
955	typedef RTGCPTR32 RTGCPTR;
956	/** Pointer to a guest context pointer. */
957	typedef PRTGCPTR32 PRTGCPTR;
958	/** Pointer to a const guest context pointer. */
959	typedef PCRTGCPTR32 PCRTGCPTR;
960	/** @def NIL_RTGCPTR
961	* NIL GC pointer.
962	*/
963	# define NIL_RTGCPTR NIL_RTGCPTR32
964	/** Max RTGCPTR value. */
965	# define RTGCPTR_MAX UINT32_MAX
966	#else
967	# error "Unsupported GC_ARCH_BITS!"
968	#endif
969
970	/** Unsigned integer register in the guest context. */
971	typedef uint32_t RTGCUINTREG32;
972	/** Pointer to an unsigned integer register in the guest context. */
973	typedef RTGCUINTREG32 *PRTGCUINTREG32;
974	/** Pointer to a const unsigned integer register in the guest context. */
975	typedef const RTGCUINTREG32 *PCRTGCUINTREG32;
976
977	typedef uint64_t RTGCUINTREG64;
978	/** Pointer to an unsigned integer register in the guest context. */
979	typedef RTGCUINTREG64 *PRTGCUINTREG64;
980	/** Pointer to a const unsigned integer register in the guest context. */
981	typedef const RTGCUINTREG64 *PCRTGCUINTREG64;
982
983	#if GC_ARCH_BITS == 64
984	typedef RTGCUINTREG64 RTGCUINTREG;
985	#elif GC_ARCH_BITS == 32
986	typedef RTGCUINTREG32 RTGCUINTREG;
987	#else
988	# error "Unsupported GC_ARCH_BITS!"
989	#endif
990	/** Pointer to an unsigned integer register in the guest context. */
991	typedef RTGCUINTREG *PRTGCUINTREG;
992	/** Pointer to a const unsigned integer register in the guest context. */
993	typedef const RTGCUINTREG *PCRTGCUINTREG;
994
995	/** @} */
996
997	/** @defgroup grp_rt_types_rc Raw mode Context Basic Types
998	* @ingroup grp_rt_types
999	* @{
1000	*/
1001
1002	/** Raw mode context pointer; a 32 bits guest context pointer.
1003	* Keep in mind that this type is an unsigned integer in
1004	* HC and void pointer in RC.
1005	*/
1006	#ifdef IN_RC
1007	typedef void * RTRCPTR;
1008	#else
1009	typedef uint32_t RTRCPTR;
1010	#endif
1011	/** Pointer to a raw mode context pointer. */
1012	typedef RTRCPTR *PRTRCPTR;
1013	/** Pointer to a const raw mode context pointer. */
1014	typedef const RTRCPTR *PCRTRCPTR;
1015	/** @def NIL_RTGCPTR
1016	* NIL RC pointer.
1017	*/
1018	#define NIL_RTRCPTR ((RTRCPTR)0)
1019	/** @def RTRCPTR_MAX
1020	* The maximum value a RTRCPTR can have. Mostly used as INVALID value.
1021	*/
1022	#define RTRCPTR_MAX ((RTRCPTR)UINT32_MAX)
1023
1024	/** Raw mode context pointer, unsigned integer variant. */
1025	typedef int32_t RTRCINTPTR;
1026	/** @def RTRCUINPTR_MAX
1027	* The maximum value a RTRCUINPTR can have.
1028	*/
1029	#define RTRCUINTPTR_MAX ((RTRCUINTPTR)UINT32_MAX)
1030
1031	/** Raw mode context pointer, signed integer variant. */
1032	typedef uint32_t RTRCUINTPTR;
1033	/** @def RTRCINPTR_MIN
1034	* The minimum value a RTRCINPTR can have.
1035	*/
1036	#define RTRCINTPTR_MIN ((RTRCINTPTR)INT32_MIN)
1037	/** @def RTRCINPTR_MAX
1038	* The maximum value a RTRCINPTR can have.
1039	*/
1040	#define RTRCINTPTR_MAX ((RTRCINTPTR)INT32_MAX)
1041
1042	/** @} */
1043
1044
1045	/** @defgroup grp_rt_types_cc Current Context Basic Types
1046	* @ingroup grp_rt_types
1047	* @{
1048	*/
1049
1050	/** Current Context Physical Memory Address.*/
1051	#ifdef IN_RC
1052	typedef RTGCPHYS RTCCPHYS;
1053	#else
1054	typedef RTHCPHYS RTCCPHYS;
1055	#endif
1056	/** Pointer to Current Context Physical Memory Address. */
1057	typedef RTCCPHYS *PRTCCPHYS;
1058	/** Pointer to const Current Context Physical Memory Address. */
1059	typedef const RTCCPHYS *PCRTCCPHYS;
1060	/** @def NIL_RTCCPHYS
1061	* NIL CC Physical Address.
1062	* NIL_RTCCPHYS is used to signal an invalid physical address, similar
1063	* to the NULL pointer.
1064	*/
1065	#ifdef IN_RC
1066	# define NIL_RTCCPHYS NIL_RTGCPHYS
1067	#else
1068	# define NIL_RTCCPHYS NIL_RTHCPHYS
1069	#endif
1070
1071	/** Unsigned integer register in the current context. */
1072	#if ARCH_BITS == 32
1073	typedef uint32_t RTCCUINTREG;
1074	#elif ARCH_BITS == 64
1075	typedef uint64_t RTCCUINTREG;
1076	#else
1077	# error "Unsupported ARCH_BITS!"
1078	#endif
1079	/** Pointer to an unsigned integer register in the current context. */
1080	typedef RTCCUINTREG *PRTCCUINTREG;
1081	/** Pointer to a const unsigned integer register in the current context. */
1082	typedef RTCCUINTREG const *PCRTCCUINTREG;
1083
1084	/** Signed integer register in the current context. */
1085	#if ARCH_BITS == 32
1086	typedef int32_t RTCCINTREG;
1087	#elif ARCH_BITS == 64
1088	typedef int64_t RTCCINTREG;
1089	#endif
1090	/** Pointer to a signed integer register in the current context. */
1091	typedef RTCCINTREG *PRTCCINTREG;
1092	/** Pointer to a const signed integer register in the current context. */
1093	typedef RTCCINTREG const *PCRTCCINTREG;
1094
1095	/** @} */
1096
1097
1098	/** File handle. */
1099	typedef RTUINT RTFILE;
1100	/** Pointer to file handle. */
1101	typedef RTFILE *PRTFILE;
1102	/** Nil file handle. */
1103	#define NIL_RTFILE (~(RTFILE)0)
1104
1105	/** Async I/O request handle. */
1106	typedef R3PTRTYPE(struct RTFILEAIOREQINTERNAL *) RTFILEAIOREQ;
1107	/** Pointer to a async I/O request handle. */
1108	typedef RTFILEAIOREQ *PRTFILEAIOREQ;
1109	/** Nil request handle. */
1110	#define NIL_RTFILEAIOREQ 0
1111
1112	/** Async I/O completion context handle. */
1113	typedef R3PTRTYPE(struct RTFILEAIOCTXINTERNAL *) RTFILEAIOCTX;
1114	/** Pointer to a async I/O completion context handle. */
1115	typedef RTFILEAIOCTX *PRTFILEAIOCTX;
1116	/** Nil context handle. */
1117	#define NIL_RTFILEAIOCTX 0
1118
1119	/** Loader module handle. */
1120	typedef R3PTRTYPE(struct RTLDRMODINTERNAL *) RTLDRMOD;
1121	/** Pointer to a loader module handle. */
1122	typedef RTLDRMOD *PRTLDRMOD;
1123	/** Nil loader module handle. */
1124	#define NIL_RTLDRMOD 0
1125
1126	/** Ring-0 memory object handle. */
1127	typedef R0PTRTYPE(struct RTR0MEMOBJINTERNAL *) RTR0MEMOBJ;
1128	/** Pointer to a Ring-0 memory object handle. */
1129	typedef RTR0MEMOBJ *PRTR0MEMOBJ;
1130	/** Nil ring-0 memory object handle. */
1131	#define NIL_RTR0MEMOBJ 0
1132
1133	/** Native thread handle. */
1134	typedef RTHCUINTPTR RTNATIVETHREAD;
1135	/** Pointer to an native thread handle. */
1136	typedef RTNATIVETHREAD *PRTNATIVETHREAD;
1137	/** Nil native thread handle. */
1138	#define NIL_RTNATIVETHREAD (~(RTNATIVETHREAD)0)
1139
1140	/** Process identifier. */
1141	typedef uint32_t RTPROCESS;
1142	/** Pointer to a process identifier. */
1143	typedef RTPROCESS *PRTPROCESS;
1144	/** Nil process identifier. */
1145	#define NIL_RTPROCESS (~(RTPROCESS)0)
1146
1147	/** Process ring-0 handle. */
1148	typedef RTR0UINTPTR RTR0PROCESS;
1149	/** Pointer to a ring-0 process handle. */
1150	typedef RTR0PROCESS *PRTR0PROCESS;
1151	/** Nil ring-0 process handle. */
1152	#define NIL_RTR0PROCESS (~(RTR0PROCESS)0)
1153
1154	/** @typedef RTSEMEVENT
1155	* Event Semaphore handle. */
1156	typedef R3R0PTRTYPE(struct RTSEMEVENTINTERNAL *) RTSEMEVENT;
1157	/** Pointer to an event semaphore handle. */
1158	typedef RTSEMEVENT *PRTSEMEVENT;
1159	/** Nil event semaphore handle. */
1160	#define NIL_RTSEMEVENT 0
1161
1162	/** @typedef RTSEMEVENTMULTI
1163	* Event Multiple Release Semaphore handle. */
1164	typedef R3R0PTRTYPE(struct RTSEMEVENTMULTIINTERNAL *) RTSEMEVENTMULTI;
1165	/** Pointer to an event multiple release semaphore handle. */
1166	typedef RTSEMEVENTMULTI *PRTSEMEVENTMULTI;
1167	/** Nil multiple release event semaphore handle. */
1168	#define NIL_RTSEMEVENTMULTI 0
1169
1170	/** @typedef RTSEMFASTMUTEX
1171	* Fast mutex Semaphore handle. */
1172	typedef R3R0PTRTYPE(struct RTSEMFASTMUTEXINTERNAL *) RTSEMFASTMUTEX;
1173	/** Pointer to a fast mutex semaphore handle. */
1174	typedef RTSEMFASTMUTEX *PRTSEMFASTMUTEX;
1175	/** Nil fast mutex semaphore handle. */
1176	#define NIL_RTSEMFASTMUTEX 0
1177
1178	/** @typedef RTSEMMUTEX
1179	* Mutex Semaphore handle. */
1180	typedef R3R0PTRTYPE(struct RTSEMMUTEXINTERNAL *) RTSEMMUTEX;
1181	/** Pointer to a mutex semaphore handle. */
1182	typedef RTSEMMUTEX *PRTSEMMUTEX;
1183	/** Nil mutex semaphore handle. */
1184	#define NIL_RTSEMMUTEX 0
1185
1186	/** @typedef RTSEMSPINMUTEX
1187	* Spinning mutex Semaphore handle. */
1188	typedef R3R0PTRTYPE(struct RTSEMSPINMUTEXINTERNAL *) RTSEMSPINMUTEX;
1189	/** Pointer to a spinning mutex semaphore handle. */
1190	typedef RTSEMSPINMUTEX *PRTSEMSPINMUTEX;
1191	/** Nil spinning mutex semaphore handle. */
1192	#define NIL_RTSEMSPINMUTEX 0
1193
1194	/** @typedef RTSEMRW
1195	* Read/Write Semaphore handle. */
1196	typedef R3R0PTRTYPE(struct RTSEMRWINTERNAL *) RTSEMRW;
1197	/** Pointer to a read/write semaphore handle. */
1198	typedef RTSEMRW *PRTSEMRW;
1199	/** Nil read/write semaphore handle. */
1200	#define NIL_RTSEMRW 0
1201
1202	/** Spinlock handle. */
1203	typedef R3R0PTRTYPE(struct RTSPINLOCKINTERNAL *) RTSPINLOCK;
1204	/** Pointer to a spinlock handle. */
1205	typedef RTSPINLOCK *PRTSPINLOCK;
1206	/** Nil spinlock handle. */
1207	#define NIL_RTSPINLOCK 0
1208
1209	/** Socket handle. */
1210	typedef int RTSOCKET;
1211	/** Pointer to socket handle. */
1212	typedef RTSOCKET *PRTSOCKET;
1213	/** Nil socket handle. */
1214	#define NIL_RTSOCKET (~(RTSOCKET)0)
1215
1216	/** Thread handle.*/
1217	typedef R3R0PTRTYPE(struct RTTHREADINT *) RTTHREAD;
1218	/** Pointer to thread handle. */
1219	typedef RTTHREAD *PRTTHREAD;
1220	/** Nil thread handle. */
1221	#define NIL_RTTHREAD 0
1222
1223	/** A TLS index. */
1224	typedef RTHCINTPTR RTTLS;
1225	/** Pointer to a TLS index. */
1226	typedef RTTLS *PRTTLS;
1227	/** Pointer to a const TLS index. */
1228	typedef RTTLS const *PCRTTLS;
1229	/** NIL TLS index value. */
1230	#define NIL_RTTLS (-1)
1231
1232	/** Handle to a simple heap. */
1233	typedef R3R0PTRTYPE(struct RTHEAPSIMPLEINTERNAL *) RTHEAPSIMPLE;
1234	/** Pointer to a handle to a simple heap. */
1235	typedef RTHEAPSIMPLE *PRTHEAPSIMPLE;
1236	/** NIL simple heap handle. */
1237	#define NIL_RTHEAPSIMPLE ((RTHEAPSIMPLE)0)
1238
1239	/** Handle to an environment block. */
1240	typedef R3PTRTYPE(struct RTENVINTERNAL *) RTENV;
1241	/** Pointer to a handle to an environment block. */
1242	typedef RTENV *PRTENV;
1243	/** NIL simple heap handle. */
1244	#define NIL_RTENV ((RTENV)0)
1245
1246	/** A CPU identifier.
1247	* @remarks This doesn't have to correspond to the APIC ID (intel/amd). Nor
1248	* does it have to correspond to the bits in the affinity mask, at
1249	* least not until we've sorted out Windows NT. */
1250	typedef uint32_t RTCPUID;
1251	/** Pointer to a CPU identifier. */
1252	typedef RTCPUID *PRTCPUID;
1253	/** Pointer to a const CPU identifier. */
1254	typedef RTCPUID const *PCRTCPUID;
1255	/** Nil CPU Id. */
1256	#define NIL_RTCPUID ((RTCPUID)~0)
1257
1258	/** A CPU set.
1259	* Treat this as an opaque type and always use RTCpuSet* for manupulating it.
1260	* @remarks Subject to change. */
1261	typedef uint64_t RTCPUSET;
1262	/** Pointer to a CPU set. */
1263	typedef RTCPUSET *PRTCPUSET;
1264	/** Pointer to a const CPU set. */
1265	typedef RTCPUSET const *PCRTCPUSET;
1266
1267	/** A handle table handle. */
1268	typedef R3R0PTRTYPE(struct RTHANDLETABLEINT *) RTHANDLETABLE;
1269	/** A pointer to a handle table handle. */
1270	typedef RTHANDLETABLE *PRTHANDLETABLE;
1271	/** @def NIL_RTHANDLETABLE
1272	* NIL handle table handle. */
1273	#define NIL_RTHANDLETABLE ((RTHANDLETABLE)0)
1274
1275	/** A handle to a low resolution timer. */
1276	typedef R3R0PTRTYPE(struct RTTIMERLRINT *) RTTIMERLR;
1277	/** A pointer to a low resolution timer handle. */
1278	typedef RTTIMERLR *PRTTIMERLR;
1279	/** @def NIL_RTTIMERLR
1280	* NIL low resolution timer handle value. */
1281	#define NIL_RTTIMERLR ((RTTIMERLR)0)
1282
1283	/** Handle to a random number generator. */
1284	typedef R3R0PTRTYPE(struct RTRANDINT *) RTRAND;
1285	/** Pointer to a random number generator handle. */
1286	typedef RTRAND *PRTRAND;
1287	/** NIL random number genrator handle value. */
1288	#define NIL_RTRAND ((RTRAND)0)
1289
1290	/** Debug address space handle. */
1291	typedef R3R0PTRTYPE(struct RTDBGASINT *) RTDBGAS;
1292	/** Pointer to a debug address space handle. */
1293	typedef RTDBGAS *PRTDBGAS;
1294	/** NIL debug address space handle. */
1295	#define NIL_RTDBGAS ((RTDBGAS)0)
1296
1297	/** Debug module handle. */
1298	typedef R3R0PTRTYPE(struct RTDBGMODINT *) RTDBGMOD;
1299	/** Pointer to a debug module handle. */
1300	typedef RTDBGMOD *PRTDBGMOD;
1301	/** NIL debug module handle. */
1302	#define NIL_RTDBGMOD ((RTDBGMOD)0)
1303
1304	/** Memory pool handle. */
1305	typedef R3R0PTRTYPE(struct RTMEMPOOLINT *) RTMEMPOOL;
1306	/** Pointer to a memory pool handle. */
1307	typedef RTMEMPOOL *PRTMEMPOOL;
1308	/** NIL memory pool handle. */
1309	#define NIL_RTMEMPOOL ((RTMEMPOOL)0)
1310	/** The default memory pool handle. */
1311	#define RTMEMPOOL_DEFAULT ((RTMEMPOOL)-2)
1312
1313	/** String cache handle. */
1314	typedef R3R0PTRTYPE(struct RTSTRCACHEINT *) RTSTRCACHE;
1315	/** Pointer to a string cache handle. */
1316	typedef RTSTRCACHE *PRTSTRCACHE;
1317	/** NIL string cache handle. */
1318	#define NIL_RTSTRCACHE ((RTSTRCACHE)0)
1319	/** The default string cache handle. */
1320	#define RTSTRCACHE_DEFAULT ((RTSTRCACHE)-2)
1321
1322
1323	/**
1324	* UUID data type.
1325	*
1326	* @note IPRT defines that the first three integers in the @c Gen struct
1327	* interpretation are in little endian representation. This is different to
1328	* many other UUID implementation, and requires conversion if you need to
1329	* achieve consistent results.
1330	*/
1331	typedef union RTUUID
1332	{
1333	/** 8-bit view. */
1334	uint8_t au8[16];
1335	/** 16-bit view. */
1336	uint16_t au16[8];
1337	/** 32-bit view. */
1338	uint32_t au32[4];
1339	/** 64-bit view. */
1340	uint64_t au64[2];
1341	/** The way the UUID is declared by the DCE specification. */
1342	struct
1343	{
1344	uint32_t u32TimeLow;
1345	uint16_t u16TimeMid;
1346	uint16_t u16TimeHiAndVersion;
1347	uint8_t u8ClockSeqHiAndReserved;
1348	uint8_t u8ClockSeqLow;
1349	uint8_t au8Node[6];
1350	} Gen;
1351	} RTUUID;
1352	/** Pointer to UUID data. */
1353	typedef RTUUID *PRTUUID;
1354	/** Pointer to readonly UUID data. */
1355	typedef const RTUUID *PCRTUUID;
1356
1357	/**
1358	* UUID string maximum length.
1359	*/
1360	#define RTUUID_STR_LENGTH 37
1361
1362
1363	/** Compression handle. */
1364	typedef struct RTZIPCOMP *PRTZIPCOMP;
1365
1366	/** Decompressor handle. */
1367	typedef struct RTZIPDECOMP *PRTZIPDECOMP;
1368
1369
1370	/**
1371	* Unicode Code Point.
1372	*/
1373	typedef uint32_t RTUNICP;
1374	/** Pointer to an Unicode Code Point. */
1375	typedef RTUNICP *PRTUNICP;
1376	/** Pointer to an Unicode Code Point. */
1377	typedef const RTUNICP *PCRTUNICP;
1378
1379
1380	/**
1381	* UTF-16 character.
1382	* @remark wchar_t is not usable since it's compiler defined.
1383	* @remark When we use the term character we're not talking about unicode code point, but
1384	* the basic unit of the string encoding. Thus cwc - count of wide chars - means
1385	* count of RTUTF16; cuc - count of unicode chars - means count of RTUNICP;
1386	* and cch means count of the typedef 'char', which is assumed to be an octet.
1387	*/
1388	typedef uint16_t RTUTF16;
1389	/** Pointer to a UTF-16 character. */
1390	typedef RTUTF16 *PRTUTF16;
1391	/** Pointer to a const UTF-16 character. */
1392	typedef const RTUTF16 *PCRTUTF16;
1393
1394
1395	/**
1396	* Wait for ever if we have to.
1397	*/
1398	#define RT_INDEFINITE_WAIT (~0U)
1399
1400
1401	/**
1402	* Generic process callback.
1403	*
1404	* @returns VBox status code. Failure will cancel the operation.
1405	* @param uPercentage The percentage of the operation which has been completed.
1406	* @param pvUser The user specified argument.
1407	*/
1408	typedef DECLCALLBACK(int) FNRTPROGRESS(unsigned uPrecentage, void *pvUser);
1409	/** Pointer to a generic progress callback function, FNRTPROCESS(). */
1410	typedef FNRTPROGRESS *PFNRTPROGRESS;
1411
1412
1413	/**
1414	* Rectangle data type.
1415	*/
1416	typedef struct RTRECT
1417	{
1418	/** left X coordinate. */
1419	int32_t xLeft;
1420	/** top Y coordinate. */
1421	int32_t yTop;
1422	/** right X coordinate. (exclusive) */
1423	int32_t xRight;
1424	/** bottom Y coordinate. (exclusive) */
1425	int32_t yBottom;
1426	} RTRECT;
1427	/** Pointer to a rectangle. */
1428	typedef RTRECT *PRTRECT;
1429	/** Pointer to a const rectangle. */
1430	typedef const RTRECT *PCRTRECT;
1431
1432
1433	/**
1434	* Ethernet MAC address.
1435	*
1436	* The first 24 bits make up the Organisationally Unique Identifier (OUI),
1437	* where the first bit (little endian) indicates multicast (set) / unicast,
1438	* and the second bit indicates locally (set) / global administered. If all
1439	* bits are set, it's a broadcast.
1440	*/
1441	typedef union RTMAC
1442	{
1443	/** @todo add a bitfield view of this stuff. */
1444	/** 8-bit view. */
1445	uint8_t au8[6];
1446	/** 16-bit view. */
1447	uint16_t au16[3];
1448	} RTMAC;
1449	/** Pointer to a MAC address. */
1450	typedef RTMAC *PRTMAC;
1451	/** Pointer to a readonly MAC address. */
1452	typedef const RTMAC *PCRTMAC;
1453
1454
1455	#ifdef __cplusplus
1456	/**
1457	* Strict type validation helper class.
1458	*
1459	* See RTErrStrictType and RT_SUCCESS_NP.
1460	*/
1461	class RTErrStrictType2
1462	{
1463	protected:
1464	/** The status code. */
1465	int32_t m_rc;
1466
1467	public:
1468	/**
1469	* Constructor.
1470	* @param rc IPRT style status code.
1471	*/
1472	RTErrStrictType2(int32_t rc) : m_rc(rc)
1473	{
1474	}
1475
1476	/**
1477	* Get the status code.
1478	* @returns IPRT style status code.
1479	*/
1480	int32_t getValue() const
1481	{
1482	return m_rc;
1483	}
1484	};
1485	#endif /* __cplusplus */
1486	/** @} */
1487
1488	#endif
1489

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

source: vbox/trunk/include/iprt/types.h@ 23305

Download in other formats: