xref: /haiku/headers/os/support/SupportDefs.h (revision 4d978eea2f9530892046f3344341ed85c9e0b1cf)
1 /*
2  * Copyright 2004-2010, Haiku, Inc. All Rights Reserved.
3  * Distributed under the terms of the MIT License.
4  *
5  * Author:
6  *		Erik Jaesler (erik@cgsoftware.com)
7  */
8 #ifndef _SUPPORT_DEFS_H
9 #define _SUPPORT_DEFS_H
10 
11 
12 #include <BeBuild.h>
13 #include <Errors.h>
14 
15 #include <inttypes.h>
16 #include <sys/types.h>
17 
18 
19 /* fixed-size integer types */
20 typedef	__haiku_int8			int8;
21 typedef __haiku_uint8			uint8;
22 typedef	__haiku_int16			int16;
23 typedef __haiku_uint16			uint16;
24 typedef	__haiku_int32			int32;
25 typedef __haiku_uint32			uint32;
26 typedef	__haiku_int64			int64;
27 typedef __haiku_uint64			uint64;
28 
29 /* shorthand types */
30 typedef volatile int8   		vint8;
31 typedef volatile uint8			vuint8;
32 typedef volatile int16			vint16;
33 typedef volatile uint16			vuint16;
34 typedef volatile int32			vint32;
35 typedef volatile uint32			vuint32;
36 typedef volatile int64			vint64;
37 typedef volatile uint64			vuint64;
38 
39 typedef volatile long			vlong;
40 typedef volatile int			vint;
41 typedef volatile short			vshort;
42 typedef volatile char			vchar;
43 
44 typedef volatile unsigned long	vulong;
45 typedef volatile unsigned int	vuint;
46 typedef volatile unsigned short	vushort;
47 typedef volatile unsigned char	vuchar;
48 
49 typedef unsigned char			uchar;
50 typedef unsigned short          unichar;
51 
52 /* descriptive types */
53 typedef int32					status_t;
54 typedef int64					bigtime_t;
55 typedef int64					nanotime_t;
56 typedef uint32					type_code;
57 typedef uint32					perform_code;
58 
59 typedef __haiku_phys_addr_t		phys_addr_t;
60 typedef phys_addr_t				phys_size_t;
61 
62 typedef	__haiku_generic_addr_t	generic_addr_t;
63 typedef	generic_addr_t			generic_size_t;
64 
65 
66 /* printf()/scanf() format strings for [u]int* types */
67 #define B_PRId8			"d"
68 #define B_PRIi8			"i"
69 #define B_PRId16		"d"
70 #define B_PRIi16		"i"
71 #define B_PRId32		__HAIKU_PRI_PREFIX_32 "d"
72 #define B_PRIi32		__HAIKU_PRI_PREFIX_32 "i"
73 #define B_PRId64		__HAIKU_PRI_PREFIX_64 "d"
74 #define B_PRIi64		__HAIKU_PRI_PREFIX_64 "i"
75 #define B_PRIu8			"u"
76 #define B_PRIo8			"o"
77 #define B_PRIx8			"x"
78 #define B_PRIX8			"X"
79 #define B_PRIu16		"u"
80 #define B_PRIo16		"o"
81 #define B_PRIx16		"x"
82 #define B_PRIX16		"X"
83 #define B_PRIu32		__HAIKU_PRI_PREFIX_32 "u"
84 #define B_PRIo32		__HAIKU_PRI_PREFIX_32 "o"
85 #define B_PRIx32		__HAIKU_PRI_PREFIX_32 "x"
86 #define B_PRIX32		__HAIKU_PRI_PREFIX_32 "X"
87 #define B_PRIu64		__HAIKU_PRI_PREFIX_64 "u"
88 #define B_PRIo64		__HAIKU_PRI_PREFIX_64 "o"
89 #define B_PRIx64		__HAIKU_PRI_PREFIX_64 "x"
90 #define B_PRIX64		__HAIKU_PRI_PREFIX_64 "X"
91 
92 #define B_SCNd8 		"hhd"
93 #define B_SCNi8 		"hhi"
94 #define B_SCNd16		"hd"
95 #define B_SCNi16	 	"hi"
96 #define B_SCNd32 		__HAIKU_PRI_PREFIX_32 "d"
97 #define B_SCNi32	 	__HAIKU_PRI_PREFIX_32 "i"
98 #define B_SCNd64		__HAIKU_PRI_PREFIX_64 "d"
99 #define B_SCNi64 		__HAIKU_PRI_PREFIX_64 "i"
100 #define B_SCNu8 		"hhu"
101 #define B_SCNo8 		"hho"
102 #define B_SCNx8 		"hhx"
103 #define B_SCNu16		"hu"
104 #define B_SCNo16		"ho"
105 #define B_SCNx16		"hx"
106 #define B_SCNu32 		__HAIKU_PRI_PREFIX_32 "u"
107 #define B_SCNo32 		__HAIKU_PRI_PREFIX_32 "o"
108 #define B_SCNx32 		__HAIKU_PRI_PREFIX_32 "x"
109 #define B_SCNu64		__HAIKU_PRI_PREFIX_64 "u"
110 #define B_SCNo64		__HAIKU_PRI_PREFIX_64 "o"
111 #define B_SCNx64		__HAIKU_PRI_PREFIX_64 "x"
112 
113 /* printf() format strings for some standard types */
114 /* size_t */
115 #define B_PRIuSIZE		__HAIKU_PRI_PREFIX_ADDR "u"
116 #define B_PRIoSIZE		__HAIKU_PRI_PREFIX_ADDR "o"
117 #define B_PRIxSIZE		__HAIKU_PRI_PREFIX_ADDR "x"
118 #define B_PRIXSIZE		__HAIKU_PRI_PREFIX_ADDR "X"
119 /* ssize_t */
120 #define B_PRIdSSIZE		__HAIKU_PRI_PREFIX_ADDR "d"
121 #define B_PRIiSSIZE		__HAIKU_PRI_PREFIX_ADDR "i"
122 /* addr_t */
123 #define B_PRIuADDR		__HAIKU_PRI_PREFIX_ADDR "u"
124 #define B_PRIoADDR		__HAIKU_PRI_PREFIX_ADDR "o"
125 #define B_PRIxADDR		__HAIKU_PRI_PREFIX_ADDR "x"
126 #define B_PRIXADDR		__HAIKU_PRI_PREFIX_ADDR "X"
127 /* phys_addr_t */
128 #define B_PRIuPHYSADDR	__HAIKU_PRI_PREFIX_PHYS_ADDR "u"
129 #define B_PRIoPHYSADDR	__HAIKU_PRI_PREFIX_PHYS_ADDR "o"
130 #define B_PRIxPHYSADDR	__HAIKU_PRI_PREFIX_PHYS_ADDR "x"
131 #define B_PRIXPHYSADDR	__HAIKU_PRI_PREFIX_PHYS_ADDR "X"
132 /* generic_addr_t */
133 #define B_PRIuGENADDR	__HAIKU_PRI_PREFIX_GENERIC_ADDR "u"
134 #define B_PRIoGENADDR	__HAIKU_PRI_PREFIX_GENERIC_ADDR "o"
135 #define B_PRIxGENADDR	__HAIKU_PRI_PREFIX_GENERIC_ADDR "x"
136 #define B_PRIXGENADDR	__HAIKU_PRI_PREFIX_GENERIC_ADDR "X"
137 /* off_t */
138 #define B_PRIdOFF		B_PRId64
139 #define B_PRIiOFF		B_PRIi64
140 /* dev_t */
141 #define B_PRIdDEV		B_PRId32
142 #define B_PRIiDEV		B_PRIi32
143 /* ino_t */
144 #define B_PRIdINO		B_PRId64
145 #define B_PRIiINO		B_PRIi64
146 /* time_t */
147 #define B_PRIdTIME		B_PRId32
148 #define B_PRIiTIME		B_PRIi32
149 
150 
151 /* Empty string ("") */
152 #ifdef __cplusplus
153 extern const char *B_EMPTY_STRING;
154 #endif
155 
156 
157 /* min and max comparisons */
158 #ifndef __cplusplus
159 #	ifndef min
160 #		define min(a,b) ((a)>(b)?(b):(a))
161 #	endif
162 #	ifndef max
163 #		define max(a,b) ((a)>(b)?(a):(b))
164 #	endif
165 #endif
166 
167 /* min() and max() are functions in C++ */
168 #define min_c(a,b) ((a)>(b)?(b):(a))
169 #define max_c(a,b) ((a)>(b)?(a):(b))
170 
171 
172 /* Grandfathering */
173 #ifndef __cplusplus
174 #	include <stdbool.h>
175 #endif
176 
177 #ifndef NULL
178 #	define NULL (0)
179 #endif
180 
181 
182 #ifdef __cplusplus
183 extern "C" {
184 #endif
185 
186 /* Atomic functions; previous value is returned */
187 extern int32	atomic_set(vint32 *value, int32 newValue);
188 extern int32	atomic_test_and_set(vint32 *value, int32 newValue, int32 testAgainst);
189 extern int32	atomic_add(vint32 *value, int32 addValue);
190 extern int32	atomic_and(vint32 *value, int32 andValue);
191 extern int32	atomic_or(vint32 *value, int32 orValue);
192 extern int32	atomic_get(vint32 *value);
193 
194 extern int64	atomic_set64(vint64 *value, int64 newValue);
195 extern int64	atomic_test_and_set64(vint64 *value, int64 newValue, int64 testAgainst);
196 extern int64	atomic_add64(vint64 *value, int64 addValue);
197 extern int64	atomic_and64(vint64 *value, int64 andValue);
198 extern int64	atomic_or64(vint64 *value, int64 orValue);
199 extern int64	atomic_get64(vint64 *value);
200 
201 /* Other stuff */
202 extern void*	get_stack_frame(void);
203 
204 #ifdef __cplusplus
205 }
206 #endif
207 
208 /* Obsolete or discouraged API */
209 
210 /* use 'true' and 'false' */
211 #ifndef FALSE
212 #	define FALSE	0
213 #endif
214 #ifndef TRUE
215 #	define TRUE		1
216 #endif
217 
218 
219 /* Use the built-in atomic functions, if requested and available. */
220 
221 #if defined(B_USE_BUILTIN_ATOMIC_FUNCTIONS) && __GNUC__ >= 4
222 
223 #define atomic_test_and_set(valuePointer, newValue, testAgainst)	\
224 	__sync_val_compare_and_swap(valuePointer, testAgainst, newValue)
225 #define atomic_add(valuePointer, addValue)	\
226 	__sync_fetch_and_add(valuePointer, addValue)
227 #define atomic_and(valuePointer, andValue)	\
228 	__sync_fetch_and_and(valuePointer, andValue)
229 #define atomic_or(valuePointer, orValue)	\
230 	__sync_fetch_and_or(valuePointer, orValue)
231 #define atomic_get(valuePointer)	\
232 	__sync_fetch_and_or(valuePointer, 0)
233 	// No equivalent to atomic_get(). We simulate it via atomic or. On most
234 	// (all?) 32+ bit architectures aligned 32 bit reads will be atomic anyway,
235 	// though.
236 
237 // Note: No equivalent for atomic_set(). It could be simulated by a
238 // get + atomic test and set loop, but calling the atomic_set() implementation
239 // might be faster.
240 
241 #endif	// B_USE_BUILTIN_ATOMIC_FUNCTIONS && __GNUC__ >= 4
242 
243 
244 #endif	/* _SUPPORT_DEFS_H */
245