types.h@ 129

Last change on this file since 129 was 129, checked in by vboxsync, 18 years ago
Generic Uuid. Corrected Gen.u16TimeMin to Gen.u16TimeMid.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 28.3 KB

Line
1	/** @file
2	* InnoTek Portable Runtime - Types.
3	*/
4
5	/*
6	* Copyright (C) 2006 InnoTek Systemberatung GmbH
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 as published by the Free Software Foundation,
12	* in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13	* distribution. VirtualBox OSE is distributed in the hope that it will
14	* be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* If you received this file as part of a commercial VirtualBox
17	* distribution, then only the terms of your commercial VirtualBox
18	* license agreement apply instead of the previous paragraph.
19	*/
20
21	#ifndef __iprt_types_h__
22	#define __iprt_types_h__
23
24	#include <iprt/cdefs.h>
25	#include <iprt/stdint.h>
26
27	/*
28	* Include standard C types.
29	*/
30	#ifndef IPRT_NO_CRT
31
32	# if !defined(__DARWIN__) \|\| !defined(KERNEL) /* Klugde for the darwin kernel. */
33	# include <stddef.h>
34	# else /* DARWIN && KERNEL */
35	# ifndef _PTRDIFF_T
36	# define _PTRDIFF_T
37	typedef __darwin_ptrdiff_t ptrdiff_t;
38	# endif
39	# endif /* DARWIN && KERNEL */
40
41	# if defined(__LINUX__) && defined(__KERNEL__) /* Klugde for the linux kernel. */
42	# ifndef bool /* Linux 2.6.19 C++ nightmare */
43	# define bool bool_type
44	# define true true_type
45	# define false false_type
46	# define _Bool int
47	# define bool_type_iprt_types_h__
48	# endif
49	# include <linux/types.h>
50	# ifdef bool_type_iprt_types_h__
51	# undef bool
52	# undef true
53	# undef false
54	# undef _Bool
55	# undef bool_type_iprt_types_h__
56	# endif
57	# else
58	# include <sys/types.h>
59	# endif
60
61	/* Define any types missing from sys/types.h on windows. */
62	# ifdef _MSC_VER
63	# undef ssize_t
64	typedef intptr_t ssize_t;
65	# endif
66	#else /* no crt */
67	# if defined(__GNUC__)
68	# ifndef __OS2__
69	# include <stddef.h>
70	# endif
71	# ifndef _SIZE_T_DECLARED
72	# define _SIZE_T_DECLARED
73	# if defined(__X86__)
74	typedef unsigned int size_t;
75	# else
76	typedef uintptr_t size_t;
77	# endif
78	# endif
79	# ifndef _SSIZE_T_DECLARED
80	# define _SSIZE_T_DECLARED
81	# if defined(__X86__)
82	typedef int ssize_t;
83	# else
84	typedef intptr_t ssize_t;
85	# endif
86	# endif
87	# else /* !__GNUC__ */
88	typedef uintptr_t size_t;
89	typedef intptr_t ssize_t;
90	# endif /* !__GNUC__ */
91	#endif /* no crt */
92
93
94
95	/** @defgroup grp_rt_types InnoTek Portable Runtime Base Types
96	* @{
97	*/
98
99	/* define wchar_t, we don't wanna include all the wcsstuff to get this. */
100	#ifdef _MSC_VER
101	# ifndef _WCHAR_T_DEFINED
102	typedef unsigned short wchar_t;
103	# define _WCHAR_T_DEFINED
104	# endif
105	#endif
106	#ifdef __GNUC__
107	/** @todo wchar_t on GNUC */
108	#endif
109
110	/*
111	* C doesn't have bool.
112	*/
113	#ifndef __cplusplus
114	typedef unsigned char bool;
115	# ifndef true
116	# define true (1)
117	# endif
118	# ifndef false
119	# define false (0)
120	# endif
121	#endif
122
123	/**
124	* 128-bit unsigned integer.
125	*/
126	#if defined(__GNUC__) && defined(__amd64__)
127	typedef __uint128_t uint128_t;
128	#else
129	typedef struct uint128_s
130	{
131	uint64_t Lo;
132	uint64_t Hi;
133	} uint128_t;
134	#endif
135
136
137	/**
138	* 128-bit signed integer.
139	*/
140	#if defined(__GNUC__) && defined(__amd64__)
141	typedef __int128_t int128_t;
142	#else
143	typedef struct int128_s
144	{
145	uint64_t lo;
146	int64_t hi;
147	} int128_t;
148	#endif
149
150
151	/**
152	* 16-bit unsigned interger union.
153	*/
154	typedef union RTUINT16U
155	{
156	/** natural view. */
157	uint16_t u;
158
159	/** 16-bit view. */
160	uint16_t au16[1];
161	/** 8-bit view. */
162	uint8_t au8[4];
163	/** 16-bit hi/lo view. */
164	struct
165	{
166	uint16_t Lo;
167	uint16_t Hi;
168	} s;
169	} RTUINT16U;
170	/** Pointer to a 16-bit unsigned interger union. */
171	typedef RTUINT16U *PRTUINT16U;
172	/** Pointer to a const 32-bit unsigned interger union. */
173	typedef const RTUINT16U *PCRTUINT16U;
174
175
176	/**
177	* 32-bit unsigned interger union.
178	*/
179	typedef union RTUINT32U
180	{
181	/** natural view. */
182	uint32_t u;
183	/** Hi/Low view. */
184	struct
185	{
186	uint16_t Lo;
187	uint16_t Hi;
188	} s;
189	/** Word view. */
190	struct
191	{
192	uint16_t w0;
193	uint16_t w1;
194	} Words;
195
196	/** 32-bit view. */
197	uint32_t au32[1];
198	/** 16-bit view. */
199	uint16_t au16[2];
200	/** 8-bit view. */
201	uint8_t au8[4];
202	} RTUINT32U;
203	/** Pointer to a 32-bit unsigned interger union. */
204	typedef RTUINT32U *PRTUINT32U;
205	/** Pointer to a const 32-bit unsigned interger union. */
206	typedef const RTUINT32U *PCRTUINT32U;
207
208
209	/**
210	* 64-bit unsigned interger union.
211	*/
212	typedef union RTUINT64U
213	{
214	/** Natural view. */
215	uint64_t u;
216	/** Hi/Low view. */
217	struct
218	{
219	uint32_t Lo;
220	uint32_t Hi;
221	} s;
222	/** Double-Word view. */
223	struct
224	{
225	uint32_t dw0;
226	uint32_t dw1;
227	} DWords;
228	/** Word view. */
229	struct
230	{
231	uint16_t w0;
232	uint16_t w1;
233	uint16_t w2;
234	uint16_t w3;
235	} Words;
236
237	/** 64-bit view. */
238	uint64_t au64[1];
239	/** 32-bit view. */
240	uint32_t au32[2];
241	/** 16-bit view. */
242	uint16_t au16[4];
243	/** 8-bit view. */
244	uint8_t au8[8];
245	} RTUINT64U;
246	/** Pointer to a 64-bit unsigned interger union. */
247	typedef RTUINT64U *PRTUINT64U;
248	/** Pointer to a const 64-bit unsigned interger union. */
249	typedef const RTUINT64U *PCRTUINT64U;
250
251
252	/**
253	* 128-bit unsigned interger union.
254	*/
255	typedef union RTUINT128U
256	{
257	/** Natural view.
258	* WARNING! This member depends on compiler supporing 128-bit stuff. */
259	uint128_t u;
260	/** Hi/Low view. */
261	struct
262	{
263	uint64_t Lo;
264	uint64_t Hi;
265	} s;
266	/** Quad-Word view. */
267	struct
268	{
269	uint64_t qw0;
270	uint64_t qw1;
271	} QWords;
272	/** Double-Word view. */
273	struct
274	{
275	uint32_t dw0;
276	uint32_t dw1;
277	uint32_t dw2;
278	uint32_t dw3;
279	} DWords;
280	/** Word view. */
281	struct
282	{
283	uint16_t w0;
284	uint16_t w1;
285	uint16_t w2;
286	uint16_t w3;
287	uint16_t w4;
288	uint16_t w5;
289	uint16_t w6;
290	uint16_t w7;
291	} Words;
292
293	/** 64-bit view. */
294	uint64_t au64[2];
295	/** 32-bit view. */
296	uint32_t au32[4];
297	/** 16-bit view. */
298	uint16_t au16[8];
299	/** 8-bit view. */
300	uint8_t au8[16];
301	} RTUINT128U;
302	/** Pointer to a 64-bit unsigned interger union. */
303	typedef RTUINT128U *PRTUINT128U;
304	/** Pointer to a const 64-bit unsigned interger union. */
305	typedef const RTUINT128U *PCRTUINT128U;
306
307
308	/** Generic function type.
309	* @see PFNRT
310	*/
311	typedef DECLCALLBACK(void) FNRT(void);
312
313	/** Generic function pointer.
314	* With -pedantic, gcc-4 complains when casting a function to a data object, for example
315	*
316	* @code
317	* void foo(void)
318	* {
319	* }
320	*
321	* void bar = (void )foo;
322	* @endcode
323	*
324	* The compiler would warn with "ISO C++ forbids casting between pointer-to-function and
325	* pointer-to-object". The purpose of this warning is not to bother the programmer but to
326	* point out that he is probably doing something dangerous, assigning a pointer to executable
327	* code to a data object.
328	*/
329	typedef FNRT *PFNRT;
330
331
332	/** @defgroup grp_rt_types_both Common Guest and Host Context Basic Types
333	* @ingroup grp_rt_types
334	* @{
335	*/
336
337	/** @def ARCH_BITS
338	* Defines the bit count of the current context.
339	*/
340	#ifndef ARCH_BITS
341	# if defined(__x86_64__) \|\| defined(__amd64__) /** @todo MSC / /* @todo get this right with gcc32. */
342	# define ARCH_BITS 64
343	# else
344	# define ARCH_BITS 32
345	# endif
346	#endif
347
348	/** @def HC_ARCH_BITS
349	* Defines the host architechture bit count.
350	*/
351	#ifndef HC_ARCH_BITS
352	# ifndef IN_GC
353	# define HC_ARCH_BITS ARCH_BITS
354	# else
355	# define HC_ARCH_BITS 32
356	# endif
357	#endif
358
359	/** @def R3_ARCH_BITS
360	* Defines the host ring-3 architechture bit count.
361	*/
362	#ifndef R3_ARCH_BITS
363	# ifdef IN_RING3
364	# define R3_ARCH_BITS ARCH_BITS
365	# else
366	# define R3_ARCH_BITS HC_ARCH_BITS
367	# endif
368	#endif
369
370	/** @def R0_ARCH_BITS
371	* Defines the host ring-0 architechture bit count.
372	*/
373	#ifndef R0_ARCH_BITS
374	# ifdef IN_RING0
375	# define R0_ARCH_BITS ARCH_BITS
376	# else
377	# define R0_ARCH_BITS HC_ARCH_BITS
378	# endif
379	#endif
380
381	/** @def GC_ARCH_BITS
382	* Defines the guest architechture bit count.
383	*/
384	#ifndef GC_ARCH_BITS
385	# ifdef IN_GC
386	# define GC_ARCH_BITS ARCH_BITS
387	# else
388	# define GC_ARCH_BITS 32
389	# endif
390	#endif
391
392
393	/** Signed integer which can contain both GC and HC pointers. */
394	#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
395	typedef int32_t RTINTPTR;
396	#elif (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
397	typedef int64_t RTINTPTR;
398	#else
399	# error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
400	#endif
401	/** Pointer to signed integer which can contain both GC and HC pointers. */
402	typedef RTINTPTR *PRTINTPTR;
403	/** Pointer const to signed integer which can contain both GC and HC pointers. */
404	typedef const RTINTPTR *PCRTINTPTR;
405
406	/** Unsigned integer which can contain both GC and HC pointers. */
407	#if (HC_ARCH_BITS == 32 && GC_ARCH_BITS == 32)
408	typedef uint32_t RTUINTPTR;
409	#elif (HC_ARCH_BITS == 64 \|\| GC_ARCH_BITS == 64)
410	typedef uint64_t RTUINTPTR;
411	#else
412	# error Unsupported HC_ARCH_BITS and/or GC_ARCH_BITS values.
413	#endif
414	/** Pointer to unsigned integer which can contain both GC and HC pointers. */
415	typedef RTUINTPTR *PRTUINTPTR;
416	/** Pointer const to unsigned integer which can contain both GC and HC pointers. */
417	typedef const RTUINTPTR *PCRTUINTPTR;
418
419	/** Signed integer. */
420	typedef int32_t RTINT;
421	/** Pointer to signed integer. */
422	typedef RTINT *PRTINT;
423	/** Pointer to const signed integer. */
424	typedef const RTINT *PCRTINT;
425
426	/** Unsigned integer. */
427	typedef uint32_t RTUINT;
428	/** Pointer to unsigned integer. */
429	typedef RTUINT *PRTUINT;
430	/** Pointer to const unsigned integer. */
431	typedef const RTUINT *PCRTUINT;
432
433	/** A file offset / size (off_t). */
434	typedef int64_t RTFOFF;
435	/** Pointer to a file offset / size. */
436	typedef RTFOFF *PRTFOFF;
437
438	/** File mode (see iprt/fs.h). */
439	typedef uint32_t RTFMODE;
440	/** Pointer to file mode. */
441	typedef RTFMODE *PRTFMODE;
442
443	/** Device unix number. */
444	typedef uint32_t RTDEV;
445	/** Pointer to a device unix number. */
446	typedef RTDEV *PRTDEV;
447
448	/** i-node number. */
449	typedef uint64_t RTINODE;
450	/** Pointer to a i-node number. */
451	typedef RTINODE *PRTINODE;
452
453	/** User id. */
454	typedef uint32_t RTUID;
455	/** Pointer to a user id. */
456	typedef RTUID *PRTUID;
457	/** NIL user id.
458	* @todo check this for portability! */
459	#define NIL_RTUID (~(RTUID)0);
460
461	/** Group id. */
462	typedef uint32_t RTGID;
463	/** Pointer to a group id. */
464	typedef RTGID *PRTGID;
465	/** NIL group id.
466	* @todo check this for portability! */
467	#define NIL_RTGID (~(RTGID)0);
468
469	/** I/O Port. */
470	typedef uint16_t RTIOPORT;
471	/** Pointer to I/O Port. */
472	typedef RTIOPORT *PRTIOPORT;
473	/** Pointer to const I/O Port. */
474	typedef const RTIOPORT *PCRTIOPORT;
475
476	/** Selector. */
477	typedef uint16_t RTSEL;
478	/** Pointer to selector. */
479	typedef RTSEL *PRTSEL;
480	/** Pointer to const selector. */
481	typedef const RTSEL *PCRTSEL;
482
483	/** Far 16-bit pointer. */
484	#pragma pack(1)
485	typedef struct RTFAR16
486	{
487	uint16_t off;
488	RTSEL sel;
489	} RTFAR16;
490	#pragma pack()
491	/** Pointer to Far 16-bit pointer. */
492	typedef RTFAR16 *PRTFAR16;
493	/** Pointer to const Far 16-bit pointer. */
494	typedef const RTFAR16 *PCRTFAR16;
495
496	/** Far 32-bit pointer. */
497	#pragma pack(1)
498	typedef struct RTFAR32
499	{
500	uint32_t off;
501	RTSEL sel;
502	} RTFAR32;
503	#pragma pack()
504	/** Pointer to Far 32-bit pointer. */
505	typedef RTFAR32 *PRTFAR32;
506	/** Pointer to const Far 32-bit pointer. */
507	typedef const RTFAR32 *PCRTFAR32;
508
509	/** Far 64-bit pointer. */
510	#pragma pack(1)
511	typedef struct RTFAR64
512	{
513	uint64_t off;
514	RTSEL sel;
515	} RTFAR64;
516	#pragma pack()
517	/** Pointer to Far 64-bit pointer. */
518	typedef RTFAR64 *PRTFAR64;
519	/** Pointer to const Far 64-bit pointer. */
520	typedef const RTFAR64 *PCRTFAR64;
521
522	/** @} */
523
524
525	/** @defgroup grp_rt_types_hc Host Context Basic Types
526	* @ingroup grp_rt_types
527	* @{
528	*/
529
530	/** HC Natural signed integer. */
531	typedef int32_t RTHCINT;
532	/** Pointer to HC Natural signed integer. */
533	typedef RTHCINT *PRTHCINT;
534	/** Pointer to const HC Natural signed integer. */
535	typedef const RTHCINT *PCRTHCINT;
536
537	/** HC Natural unsigned integer. */
538	typedef uint32_t RTHCUINT;
539	/** Pointer to HC Natural unsigned integer. */
540	typedef RTHCUINT *PRTHCUINT;
541	/** Pointer to const HC Natural unsigned integer. */
542	typedef const RTHCUINT *PCRTHCUINT;
543
544
545	/** Signed integer which can contain a HC pointer. */
546	#if HC_ARCH_BITS == 32
547	typedef int32_t RTHCINTPTR;
548	#elif HC_ARCH_BITS == 64
549	typedef int64_t RTHCINTPTR;
550	#else
551	# error Unsupported HC_ARCH_BITS value.
552	#endif
553	/** Pointer to signed interger which can contain a HC pointer. */
554	typedef RTHCINTPTR *PRTHCINTPTR;
555	/** Pointer to const signed interger which can contain a HC pointer. */
556	typedef const RTHCINTPTR *PCRTHCINTPTR;
557
558	/** Signed integer which can contain a HC ring-3 pointer. */
559	#if R3_ARCH_BITS == 32
560	typedef int32_t RTR3INTPTR;
561	#elif R3_ARCH_BITS == 64
562	typedef int64_t RTR3INTPTR;
563	#else
564	# error Unsupported R3_ARCH_BITS value.
565	#endif
566	/** Pointer to signed interger which can contain a HC ring-3 pointer. */
567	typedef RTR3INTPTR *PRTR3INTPTR;
568	/** Pointer to const signed interger which can contain a HC ring-3 pointer. */
569	typedef const RTR3INTPTR *PCRTR3INTPTR;
570
571	/** Signed integer which can contain a HC ring-0 pointer. */
572	#if R0_ARCH_BITS == 32
573	typedef int32_t RTR0INTPTR;
574	#elif R0_ARCH_BITS == 64
575	typedef int64_t RTR0INTPTR;
576	#else
577	# error Unsupported R0_ARCH_BITS value.
578	#endif
579	/** Pointer to signed interger which can contain a HC ring-0 pointer. */
580	typedef RTR0INTPTR *PRTR0INTPTR;
581	/** Pointer to const signed interger which can contain a HC ring-0 pointer. */
582	typedef const RTR0INTPTR *PCRTR0INTPTR;
583
584
585	/** Unsigned integer which can contain a HC pointer. */
586	#if HC_ARCH_BITS == 32
587	typedef uint32_t RTHCUINTPTR;
588	#elif HC_ARCH_BITS == 64
589	typedef uint64_t RTHCUINTPTR;
590	#else
591	# error Unsupported HC_ARCH_BITS value.
592	#endif
593	/** Pointer to unsigned interger which can contain a HC pointer. */
594	typedef RTHCUINTPTR *PRTHCUINTPTR;
595	/** Pointer to unsigned interger which can contain a HC pointer. */
596	typedef const RTHCUINTPTR *PCRTHCUINTPTR;
597
598	/** Unsigned integer which can contain a HC ring-3 pointer. */
599	#if R3_ARCH_BITS == 32
600	typedef uint32_t RTR3UINTPTR;
601	#elif R3_ARCH_BITS == 64
602	typedef uint64_t RTR3UINTPTR;
603	#else
604	# error Unsupported R3_ARCH_BITS value.
605	#endif
606	/** Pointer to unsigned interger which can contain a HC ring-3 pointer. */
607	typedef RTR3UINTPTR *PRTR3UINTPTR;
608	/** Pointer to unsigned interger which can contain a HC ring-3 pointer. */
609	typedef const RTR3UINTPTR *PCRTR3UINTPTR;
610
611	/** Unsigned integer which can contain a HC ring-0 pointer. */
612	#if R0_ARCH_BITS == 32
613	typedef uint32_t RTR0UINTPTR;
614	#elif R0_ARCH_BITS == 64
615	typedef uint64_t RTR0UINTPTR;
616	#else
617	# error Unsupported R0_ARCH_BITS value.
618	#endif
619	/** Pointer to unsigned interger which can contain a HC ring-0 pointer. */
620	typedef RTR0UINTPTR *PRTR0UINTPTR;
621	/** Pointer to unsigned interger which can contain a HC ring-0 pointer. */
622	typedef const RTR0UINTPTR *PCRTR0UINTPTR;
623
624
625	/** Host Physical Memory Address.
626	* @todo This should be configurable at compile time too...
627	*/
628	typedef uint64_t RTHCPHYS;
629	/** Pointer to Host Physical Memory Address. */
630	typedef RTHCPHYS *PRTHCPHYS;
631	/** Pointer to const Host Physical Memory Address. */
632	typedef const RTHCPHYS *PCRTHCPHYS;
633	/** @def NIL_RTHCPHYS
634	* NIL HC Physical Address.
635	* NIL_RTHCPHYS is used to signal an invalid physical address, similar
636	* to the NULL pointer.
637	*/
638	#define NIL_RTHCPHYS ((RTHCPHYS)~0U) /** @todo change this to (~(VBOXHCPHYS)0) */
639
640
641	/** HC pointer. */
642	#ifndef IN_GC
643	typedef void * RTHCPTR;
644	#else
645	typedef RTHCUINTPTR RTHCPTR;
646	#endif
647	/** Pointer to HC pointer. */
648	typedef RTHCPTR *PRTHCPTR;
649	/** Pointer to const HC pointer. */
650	typedef const RTHCPTR *PCRTHCPTR;
651	/** @def NIL_RTHCPTR
652	* NIL HC pointer.
653	*/
654	#define NIL_RTHCPTR ((RTHCPTR)0)
655
656	/** HC ring-3 pointer. */
657	#ifdef IN_RING3
658	typedef void * RTR3PTR;
659	#else
660	typedef RTR3UINTPTR RTR3PTR;
661	#endif
662	/** Pointer to HC ring-3 pointer. */
663	typedef RTR3PTR *PRTR3PTR;
664	/** Pointer to const HC ring-3 pointer. */
665	typedef const RTR3PTR *PCRTR3PTR;
666	/** @def NIL_RTR3PTR
667	* NIL HC ring-3 pointer.
668	*/
669	#define NIL_RTR3PTR ((RTR3PTR)0)
670
671	/** HC ring-0 pointer. */
672	#ifdef IN_RING0
673	typedef void * RTR0PTR;
674	#else
675	typedef RTR0UINTPTR RTR0PTR;
676	#endif
677	/** Pointer to HC ring-0 pointer. */
678	typedef RTR0PTR *PRTR0PTR;
679	/** Pointer to const HC ring-0 pointer. */
680	typedef const RTR0PTR *PCRTR0PTR;
681	/** @def NIL_RTR0PTR
682	* NIL HC ring-0 pointer.
683	*/
684	#define NIL_RTR0PTR ((RTR0PTR)0)
685
686
687	/** Unsigned integer register in the host context. */
688	#if HC_ARCH_BITS == 32
689	typedef uint32_t RTHCUINTREG;
690	#elif HC_ARCH_BITS == 64
691	typedef uint64_t RTHCUINTREG;
692	#else
693	# error "Unsupported HC_ARCH_BITS!"
694	#endif
695	/** Pointer to an unsigned integer register in the host context. */
696	typedef RTHCUINTREG *PRTHCUINTREG;
697	/** Pointer to a const unsigned integer register in the host context. */
698	typedef const RTHCUINTREG *PCRTHCUINTREG;
699
700	/** Unsigned integer register in the host ring-3 context. */
701	#if R3_ARCH_BITS == 32
702	typedef uint32_t RTR3UINTREG;
703	#elif R3_ARCH_BITS == 64
704	typedef uint64_t RTR3UINTREG;
705	#else
706	# error "Unsupported R3_ARCH_BITS!"
707	#endif
708	/** Pointer to an unsigned integer register in the host ring-3 context. */
709	typedef RTR3UINTREG *PRTR3UINTREG;
710	/** Pointer to a const unsigned integer register in the host ring-3 context. */
711	typedef const RTR3UINTREG *PCRTR3UINTREG;
712
713	/** Unsigned integer register in the host ring-3 context. */
714	#if R0_ARCH_BITS == 32
715	typedef uint32_t RTR0UINTREG;
716	#elif R0_ARCH_BITS == 64
717	typedef uint64_t RTR0UINTREG;
718	#else
719	# error "Unsupported R3_ARCH_BITS!"
720	#endif
721	/** Pointer to an unsigned integer register in the host ring-3 context. */
722	typedef RTR0UINTREG *PRTR0UINTREG;
723	/** Pointer to a const unsigned integer register in the host ring-3 context. */
724	typedef const RTR0UINTREG *PCRTR0UINTREG;
725
726	/** @} */
727
728
729	/** @defgroup grp_rt_types_gc Guest Context Basic Types
730	* @ingroup grp_rt_types
731	* @{
732	*/
733
734	/** Natural signed integer in the GC. */
735	typedef int32_t RTGCINT;
736	/** Pointer to natural signed interger in GC. */
737	typedef RTGCINT *PRTGCINT;
738	/** Pointer to const natural signed interger in GC. */
739	typedef const RTGCINT *PCRTGCINT;
740
741	/** Natural signed uninteger in the GC. */
742	typedef uint32_t RTGCUINT;
743	/** Pointer to natural unsigned interger in GC. */
744	typedef RTGCUINT *PRTGCUINT;
745	/** Pointer to const natural unsigned interger in GC. */
746	typedef const RTGCUINT *PCRTGCUINT;
747
748	/** Signed integer which can contain a GC pointer. */
749	#if GC_ARCH_BITS == 32
750	typedef int32_t RTGCINTPTR;
751	#elif GC_ARCH_BITS == 64
752	typedef int64_t RTGCINTPTR;
753	#else
754	# error Unsupported GC_ARCH_BITS value.
755	#endif
756	/** Pointer to signed interger which can contain a GC pointer. */
757	typedef RTGCINTPTR *PRTGCINTPTR;
758	/** Pointer to const signed interger which can contain a GC pointer. */
759	typedef const RTGCINTPTR *PCRTGCINTPTR;
760
761	/** Unsigned integer which can contain a GC pointer. */
762	#if GC_ARCH_BITS == 32
763	typedef uint32_t RTGCUINTPTR;
764	#elif GC_ARCH_BITS == 64
765	typedef uint64_t RTGCUINTPTR;
766	#else
767	# error Unsupported GC_ARCH_BITS value.
768	#endif
769	/** Pointer to unsigned interger which can contain a GC pointer. */
770	typedef RTGCUINTPTR *PRTGCUINTPTR;
771	/** Pointer to unsigned interger which can contain a GC pointer. */
772	typedef const RTGCUINTPTR *PCRTGCUINTPTR;
773
774	/** Guest Physical Memory Address.*/
775	typedef RTGCUINTPTR RTGCPHYS;
776	/** Pointer to Guest Physical Memory Address. */
777	typedef RTGCPHYS *PRTGCPHYS;
778	/** Pointer to const Guest Physical Memory Address. */
779	typedef const RTGCPHYS *PCRTGCPHYS;
780	/** @def NIL_RTGCPHYS
781	* NIL GC Physical Address.
782	* NIL_RTGCPHYS is used to signal an invalid physical address, similar
783	* to the NULL pointer.
784	*/
785	#define NIL_RTGCPHYS ((RTGCPHYS)~0U) /** @todo change this to (~(RTGCPHYS)0) */
786
787
788	/** Guest context pointer.
789	* Keep in mind that this type is an unsigned integer in
790	* HC and void pointer in GC.
791	*/
792	#ifdef IN_GC
793	typedef void *RTGCPTR;
794	#else
795	typedef RTGCUINTPTR RTGCPTR;
796	#endif
797	/** Pointer to a guest context pointer. */
798	typedef RTGCPTR *PRTGCPTR;
799	/** Pointer to a const guest context pointer. */
800	typedef const RTGCPTR *PCRTGCPTR;
801	/** @def NIL_RTGCPTR
802	* NIL GC pointer.
803	*/
804	#define NIL_RTGCPTR ((RTGCPTR)0)
805
806
807	/** Unsigned integer register in the guest context. */
808	#if GC_ARCH_BITS == 32
809	typedef uint32_t RTGCUINTREG;
810	#elif GC_ARCH_BITS == 64
811	typedef uint64_t RTGCUINTREG;
812	#else
813	# error "Unsupported GC_ARCH_BITS!"
814	#endif
815	/** Pointer to an unsigned integer register in the guest context. */
816	typedef RTGCUINTREG *PRTGCUINTREG;
817	/** Pointer to a const unsigned integer register in the guest context. */
818	typedef const RTGCUINTREG *PCRTGCUINTREG;
819
820	/** @} */
821
822
823	/** @defgroup grp_rt_types_cc Current Context Basic Types
824	* @ingroup grp_rt_types
825	* @{
826	*/
827
828	/** Current Context Physical Memory Address.*/
829	#ifdef IN_GC
830	typedef RTGCPHYS RTCCPHYS;
831	#else
832	typedef RTHCPHYS RTCCPHYS;
833	#endif
834	/** Pointer to Current Context Physical Memory Address. */
835	typedef RTCCPHYS *PRTCCPHYS;
836	/** Pointer to const Current Context Physical Memory Address. */
837	typedef const RTCCPHYS *PCRTCCPHYS;
838	/** @def NIL_RTCCPHYS
839	* NIL CC Physical Address.
840	* NIL_RTCCPHYS is used to signal an invalid physical address, similar
841	* to the NULL pointer.
842	*/
843	#ifdef IN_GC
844	# define NIL_RTCCPHYS NIL_RTGCPHYS
845	#else
846	# define NIL_RTCCPHYS NIL_RTHCPHYS
847	#endif
848
849	/** Unsigned integer register in the current context. */
850	#if ARCH_BITS == 32
851	typedef uint32_t RTCCUINTREG;
852	#elif ARCH_BITS == 64
853	typedef uint64_t RTCCUINTREG;
854	#else
855	# error "Unsupported ARCH_BITS!"
856	#endif
857	/** Pointer to an unsigned integer register in the current context. */
858	typedef RTCCUINTREG *PRTCCUINTREG;
859	/** Pointer to a const unsigned integer register in the current context. */
860	typedef const RTCCUINTREG *PCRTCCUINTREG;
861
862	/** @deprecated */
863	typedef RTCCUINTREG RTUINTREG;
864	/** @deprecated */
865	typedef RTCCUINTREG *PRTUINTREG;
866	/** @deprecated */
867	typedef const RTCCUINTREG *PCRTUINTREG;
868
869	/** @} */
870
871
872	/** File handle. */
873	typedef RTUINT RTFILE;
874	/** Pointer to file handle. */
875	typedef RTFILE *PRTFILE;
876	/** Nil file handle. */
877	#define NIL_RTFILE (~(RTFILE)0)
878
879	/** Loader module handle. */
880	typedef HCPTRTYPE(struct RTLDRMODINTERNAL *) RTLDRMOD;
881	/** Pointer to a loader module handle. */
882	typedef RTLDRMOD *PRTLDRMOD;
883	/** Nil loader module handle. */
884	#define NIL_RTLDRMOD 0
885
886	/** Ring-0 memory object handle. */
887	typedef R0PTRTYPE(struct RTR0MEMOBJINTERNAL *) RTR0MEMOBJ;
888	/** Pointer to a Ring-0 memory object handle. */
889	typedef RTR0MEMOBJ *PRTR0MEMOBJ;
890	/** Nil ring-0 memory object handle. */
891	#define NIL_RTR0MEMOBJ 0
892
893	/** Native thread handle. */
894	typedef RTHCUINTPTR RTNATIVETHREAD;
895	/** Pointer to an native thread handle. */
896	typedef RTNATIVETHREAD *PRTNATIVETHREAD;
897	/** Nil native thread handle. */
898	#define NIL_RTNATIVETHREAD (~(RTNATIVETHREAD)0)
899
900	/** Process handle. */
901	typedef RTUINT RTPROCESS;
902	/** Pointer to a process handle. */
903	typedef RTPROCESS *PRTPROCESS;
904	/** Nil process handle. */
905	#define NIL_RTPROCESS (~(RTPROCESS)0)
906
907	/** @typedef RTSEMEVENT
908	* Event Semaphore handle. */
909	typedef HCPTRTYPE(struct RTSEMEVENTINTERNAL *) RTSEMEVENT;
910	/** Pointer to an event semaphore handle. */
911	typedef RTSEMEVENT *PRTSEMEVENT;
912	/** Nil event semaphore handle. */
913	#define NIL_RTSEMEVENT 0
914
915	/** @typedef RTSEMEVENTMULTI
916	* Event Multiple Release Semaphore handle. */
917	typedef HCPTRTYPE(struct RTSEMEVENTMULTIINTERNAL *) RTSEMEVENTMULTI;
918	/** Pointer to an event multiple release semaphore handle. */
919	typedef RTSEMEVENTMULTI *PRTSEMEVENTMULTI;
920	/** Nil multiple release event semaphore handle. */
921	#define NIL_RTSEMEVENTMULTI 0
922
923	/** @typedef RTSEMFASTMUTEX
924	* Fast mutex Semaphore handle. */
925	typedef HCPTRTYPE(struct RTSEMFASTMUTEXINTERNAL *) RTSEMFASTMUTEX;
926	/** Pointer to a mutex semaphore handle. */
927	typedef RTSEMFASTMUTEX *PRTSEMFASTMUTEX;
928	/** Nil fast mutex semaphore handle. */
929	#define NIL_RTSEMFASTMUTEX 0
930
931	/** @typedef RTSEMMUTEX
932	* Mutex Semaphore handle. */
933	typedef HCPTRTYPE(struct RTSEMMUTEXINTERNAL *) RTSEMMUTEX;
934	/** Pointer to a mutex semaphore handle. */
935	typedef RTSEMMUTEX *PRTSEMMUTEX;
936	/** Nil mutex semaphore handle. */
937	#define NIL_RTSEMMUTEX 0
938
939	/** @typedef RTSEMRW
940	* Read/Write Semaphore handle. */
941	typedef HCPTRTYPE(struct RTSEMRWINTERNAL *) RTSEMRW;
942	/** Pointer to a read/write semaphore handle. */
943	typedef RTSEMRW *PRTSEMRW;
944	/** Nil read/write semaphore handle. */
945	#define NIL_RTSEMRW 0
946
947	/** Spinlock handle. */
948	typedef HCPTRTYPE(struct RTSPINLOCKINTERNAL *) RTSPINLOCK;
949	/** Pointer to a spinlock handle. */
950	typedef RTSPINLOCK *PRTSPINLOCK;
951	/** Nil spinlock handle. */
952	#define NIL_RTSPINLOCK 0
953
954	/** Socket handle. */
955	typedef int RTSOCKET;
956	/** Pointer to socket handle. */
957	typedef RTSOCKET *PRTSOCKET;
958	/** Nil socket handle. */
959	#define NIL_RTSOCKET (~(RTSOCKET)0)
960
961	/** Thread handle.*/
962	typedef HCPTRTYPE(struct RTTHREADINT *) RTTHREAD;
963	/** Pointer to thread handle. */
964	typedef RTTHREAD *PRTTHREAD;
965	/** Nil thread handle. */
966	#define NIL_RTTHREAD 0
967
968
969
970
971	/**
972	* UUID data type.
973	*/
974	typedef union RTUUID
975	{
976	/** 8-bit view. */
977	uint8_t au8[16];
978	/** 16-bit view. */
979	uint16_t au16[8];
980	/** 32-bit view. */
981	uint32_t au32[4];
982	/** 64-bit view. */
983	uint64_t au64[2];
984	/** The way the UUID is declared by the ext2 guys. */
985	struct
986	{
987	uint32_t u32TimeLow;
988	uint16_t u16TimeMid;
989	uint16_t u16TimeHiAndVersion;
990	uint16_t u16ClockSeq;
991	uint8_t au8Node[6];
992	} Gen;
993	/** @deprecated */
994	unsigned char aUuid[16];
995	} RTUUID;
996	/** Pointer to UUID data. */
997	typedef RTUUID *PRTUUID;
998	/** Pointer to readonly UUID data. */
999	typedef const RTUUID *PCRTUUID;
1000
1001	/**
1002	* UUID string maximum length.
1003	*/
1004	#define RTUUID_STR_LENGTH 37
1005
1006
1007	/** Compression handle. */
1008	typedef struct RTZIPCOMP *PRTZIPCOMP;
1009
1010	/** Decompressor handle. */
1011	typedef struct RTZIPDECOMP *PRTZIPDECOMP;
1012
1013
1014	/**
1015	* Unicode Code Point.
1016	*/
1017	typedef uint32_t RTUNICP;
1018	/** Pointer to an Unicode Code Point. */
1019	typedef RTUNICP *PRTUNICP;
1020	/** Pointer to an Unicode Code Point. */
1021	typedef const RTUNICP *PCRTUNICP;
1022
1023
1024	/**
1025	* UTF-16 character.
1026	* @remark wchar_t is not usable since it's compiler defined.
1027	* @remark When we use the term character we're not talking about unicode code point, but
1028	* the basic unit of the string encoding. Thus cuc - count of unicode chars - means
1029	* count of RTUTF16. And cch means count of the typedef 'char', which is assumed
1030	* to be an octet.
1031	*/
1032	typedef uint16_t RTUTF16;
1033	/** Pointer to a UTF-16 character. */
1034	typedef RTUTF16 *PRTUTF16;
1035	/** Pointer to a const UTF-16 character. */
1036	typedef const RTUTF16 *PCRTUTF16;
1037
1038	/**
1039	* UCS-2 character.
1040	* @remark wchar_t is not usable since it's compiler defined.
1041	* @deprecated Use RTUTF16!
1042	*/
1043	typedef RTUTF16 RTUCS2;
1044	/** Pointer to UCS-2 character.
1045	* @deprecated Use PRTUTF16!
1046	*/
1047	typedef PRTUTF16 PRTUCS2;
1048	/** Pointer to const UCS-2 character.
1049	* @deprecated Use PCRTUTF16!
1050	*/
1051	typedef PCRTUTF16 PCRTUCS2;
1052
1053
1054
1055	/**
1056	* Wait for ever if we have to.
1057	*/
1058	#define RT_INDEFINITE_WAIT (~0U)
1059
1060
1061	/**
1062	* Generic process callback.
1063	*
1064	* @returns VBox status code. Failure will cancel the operation.
1065	* @param uPercentage The percentage of the operation which has been completed.
1066	* @param pvUser The user specified argument.
1067	*/
1068	typedef DECLCALLBACK(int) FNRTPROGRESS(unsigned uPrecentage, void *pvUser);
1069	/** Pointer to a generic progress callback function, FNRTPROCESS(). */
1070	typedef FNRTPROGRESS *PFNRTPROGRESS;
1071
1072
1073	/** @} */
1074
1075	#endif
1076

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

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

Download in other formats: