types.h@ 13575

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

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

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

Download in other formats: