a9d22f530c9c25e84392880131b21f1fef62a09a
[openafs.git] / src / config / stds.h
1 /*
2  * Copyright 2000, International Business Machines Corporation and others.
3  * All Rights Reserved.
4  * 
5  * This software has been released under the terms of the IBM Public
6  * License.  For details, see the LICENSE file in the top-level source
7  * directory or online at http://www.openafs.org/dl/license10.html
8  */
9
10 #ifndef OPENAFS_AFS_CONFIG_STDS_H
11 #define OPENAFS_AFS_CONFIG_STDS_H       1
12
13 #include <afs/param.h>
14 #include <sys/types.h>
15
16 #define IN                      /* indicates a parameter is read in */
17 #define OUT                     /* indicates a parameter is sent out (a ptr) */
18 #define INOUT                   /* indicates a parameter is read in and sent out (a ptr) */
19
20 #ifndef MACRO_BEGIN
21 #define MACRO_BEGIN     do {
22 #endif
23 #ifndef MACRO_END
24 #define MACRO_END       } while (0)
25 #endif
26
27 typedef void *opaque;
28
29 #ifndef _ATT4
30 #if defined(__HIGHC__)
31 /*
32  * keep HC from complaining about the use of "old-style" function definitions
33  * with prototypes
34  */
35 pragma Off(Prototype_override_warnings);
36 #endif /* defined(__HIGHC__) */
37 #endif
38
39 /* Now some types to enhance portability.  Always use these on the wire or when
40  * laying out shared structures on disk. */
41
42 /* Imagine that this worked...
43 #if (sizeof(long) != 4) || (sizeof(short) != 2)
44 #error We require size of long and pointers to be equal
45 #endif */
46
47 #define MAX_AFS_INT32 0x7FFFFFFF
48 #define MIN_AFS_INT32 (-MAX_AFS_INT32 - 1)
49 #define MAX_AFS_UINT32 0xFFFFFFFF
50 #define MAX_AFS_INT64 0x7FFFFFFFFFFFFFFFL
51 #define MIN_AFS_INT64 (-MAX_AFS_INT64 - 1)
52 #define MAX_AFS_UINT64 0xFFFFFFFFFFFFFFFFL
53
54 #ifndef HAVE_SSIZE_T
55 typedef int ssize_t;
56 #endif
57
58 #ifndef HAVE_SIG_ATOMIC_T
59 typedef int sig_atomic_t;
60 #endif
61
62 typedef short afs_int16;
63 typedef unsigned short afs_uint16;
64 #ifdef  AFS_64BIT_ENV
65 typedef int afs_int32;
66 typedef unsigned int afs_uint32;
67 #if defined(AFS_NT40_ENV) && defined(_MSC_VER)
68 typedef __int64 afs_int64;
69 typedef unsigned __int64 afs_uint64;
70 #else
71 typedef long long afs_int64;
72 typedef unsigned long long afs_uint64;
73 #endif
74 #define ZeroInt64(a)       (a = 0)
75 #define AssignInt64(a, b) *(b) = (a) 
76 #define IncInt64(a) (*(a))++
77 #define IncUInt64(a) (*(a))++
78 #define DecInt64(a) (*(a))--
79 #define DecUInt64(a) (*(a))--
80 #define GTInt64(a,b) ((a) > (b))
81 #define GEInt64(a,b) ((a) >= (b))
82 #define LEInt64(a,b) ((a) <= (b))
83 #define LTInt64(a,b) ((a) < (b))
84 #define AddInt64(a,b,c) *(c) = (afs_int64)(a) + (afs_int64)(b)
85 #define AddUInt64(a,b,c) *(c) = (afs_uint64)(a) + (afs_uint64)(b)
86 #define SubtractInt64(a,b,c) *(c) = (afs_int64)(a) - (afs_int64)(b)
87 #define SubtractUInt64(a,b,c) *(c) = (afs_uint64)(a) - (afs_uint64)(b)
88 #define CompareInt64(a,b) (afs_int64)(a) - (afs_int64)(b)
89 #define CompareUInt64(a,b) (afs_uint64)(a) - (afs_uint64)(b)
90 #define NonZeroInt64(a)                (a)
91 #define Int64ToInt32(a)    (a) & MAX_AFS_UINT32
92 #define FillInt64(t,h,l) (t) = ((afs_int64)(h) << 32) | (l);
93 #define SplitInt64(t,h,l) (h) = ((afs_int64)t) >> 32; (l) = (t) & MAX_AFS_UINT32;
94 #define RoundInt64ToInt32(a)    (a > MAX_AFS_UINT32) ? MAX_AFS_UINT32 : a;
95 #define RoundInt64ToInt31(a)    (a > MAX_AFS_INT32) ? MAX_AFS_INT32 : a;
96 #else /* AFS_64BIT_ENV */
97 typedef long afs_int32;
98 typedef unsigned long afs_uint32;
99
100 struct Int64 {
101     afs_int32 high;
102     afs_uint32 low;
103 };
104 typedef struct Int64 afs_int64;
105
106 struct u_Int64 {
107     afs_uint32 high;
108     afs_uint32 low;
109 };
110 typedef struct u_Int64 afs_uint64;
111 #define ZeroInt64(a) ((a).high = (a).low = 0)
112 #define AssignInt64(a, b) (b)->high = (a).high; (b)->low = (a).low
113 #define IncInt64(a) ((++((a)->low)) ? 0 : (a)->high++ )
114 #define IncUInt64(a) ((++((a)->low)) ? 0 : (a)->high++ )
115 #define DecInt64(a) (((a)->low)-- ? 0 : (a)->high-- )
116 #define DecUInt64(a) (((a)->low)-- ? 0 : (a)->high-- )
117 #define GTInt64(a,b) (((a).high > (b).high) || (((a).high == (b).high) && ((a).low > (b).low)))
118 #define GEInt64(a,b) (((a).high > (b).high) || (((a).high == (b).high) && ((a).low >= (b).low)))
119 #define LEInt64(a,b) (((a).high < (b).high) || (((a).high == (b).high) && ((a).low <= (b).low)))
120 #define LTInt64(a,b) (((a).high < (b).high) || (((a).high == (b).high) && ((a).low < (b).low)))
121 #define CompareInt64(a,b) (((afs_int32)(a).high - (afs_int32)(b).high) || (((a).high == (b).high) && ((a).low - (b).low))) 
122 #define AddInt64(a, b, c) {  afs_int64 _a, _b; _a = a; _b = b; (c)->low = _a.low + _b.low; (c)->high = _a.high + _b.high + ((c)->low < _b.low); } 
123 #define SubtractInt64(a, b, c) { afs_int64 _a, _b; _a = a; _b = b; (c)->low = _a.low - _b.low;  (c)->high = _a.high - _b.high - (_a.low < _b.low); } 
124 #define CompareUInt64(a,b) (((afs_uint32)(a).high - (afs_uint32)(b).high) || (((a).high == (b).high) && ((a).low - (b).low))) 
125 #define AddUInt64(a, b, c) {  afs_uint64 _a, _b; _a = a; _b = b; (c)->low = _a.low + _b.low; (c)->high = _a.high + _b.high + ((c)->low < _b.low); } 
126 #define SubtractUInt64(a, b, c) { afs_uint64 _a, _b; _a = a; _b = b; (c)->low = _a.low - _b.low;  (c)->high = _a.high - _b.high - (_a.low < _b.low); } 
127 #define NonZeroInt64(a)   (a).low || (a).high
128 #define Int64ToInt32(a)    (a).low
129 #define FillInt64(t,h,l) (t).high = (h); (t).low = (l);
130 #define SplitInt64(t,h,l) (h) = (t).high; (l) = (t).low;
131 #define RoundInt64ToInt32(a)    (a.high > 0) ? MAX_AFS_UINT32 : a.low;
132 #define RoundInt64ToInt31(a)    (a.high > 0) ? MAX_AFS_INT32 : a.low;
133 #endif /* AFS_64BIT_ENV */
134
135 /* AFS_64BIT_CLIENT should presently be set only for AFS_64BIT_ENV systems */
136
137 #ifdef AFS_64BIT_CLIENT
138 typedef afs_int64 afs_size_t;
139 typedef afs_uint64 afs_offs_t;
140 #else /* AFS_64BIT_CLIENT */
141 typedef afs_int32 afs_size_t;
142 typedef afs_uint32 afs_offs_t;
143 #endif /* AFS_64BIT_CLIENT */
144
145 typedef afs_int64 afs_foff_t;
146 typedef afs_uint64 afs_fsize_t;
147 typedef afs_int64 afs_sfsize_t;
148 #define SplitOffsetOrSize(t,h,l) SplitInt64(t,h,l)
149
150 /* Maximum integer sizes.  Also what is expected by %lld, %llu in
151  * afs_snprintf. */
152 #ifdef AFS_64BIT_CLIENT
153 typedef afs_int64 afs_intmax_t;
154 typedef afs_uint64 afs_uintmax_t;
155 #else /* !AFS_64BIT_CLIENT */
156 typedef afs_int32 afs_intmax_t;
157 typedef afs_uint32 afs_uintmax_t;
158 #endif /* !AFS_64BIT_CLIENT */
159
160 /* you still have to include <netinet/in.h> to make these work */
161
162 #define hton32 htonl
163 #define hton16 htons
164 #define ntoh32 ntohl
165 #define ntoh16 ntohs
166
167
168 /* Since there is going to be considerable use of 64 bit integers we provide
169  * some assistence in this matter.  The hyper type is supposed to be compatible
170  * with the afsHyper type: the same macros will work on both. */
171
172 #if     defined(AFS_64BIT_ENV) && 0
173
174 typedef unsigned long afs_hyper_t;
175
176 #define hcmp(a,b)       ((a) < (b) ? -1 : ((a) > (b) ? 1 : 0))
177 #define hsame(a,b)      ((a) == (b))
178 #define hiszero(a)      ((a) == 0)
179 #define hfitsin32(a)    ((a) & 0xffffffff00000000) == 0)
180 #define hset(a,b)       ((a) = (b))
181 #define hzero(a)        ((a) = 0)
182 #define hones(a)        ((a) = ~((unsigned long)0))
183 #define hget32(i,a)     ((i) = (unsigned int)(a))
184 #define hget64(hi,lo,a) ((lo) = ((unsigned int)(a)), (hi) = ((a) & (0xffffffff00000000)))
185 #define hset32(a,i)     ((a) = ((unsigned int)(i)))
186 #define hset64(a,hi,lo) ((a) = (((hi) << 32) | (lo)))
187 #define hgetlo(a)       ((a) & 0xffffffff)
188 #define hgethi(a)       (((unsigned int)(a)) >> 32)
189 #define hadd(a,b)       ((a) += (b))
190 /* XXX */
191 #define hadd32(a,b)     ((a) += (b))
192 #define hshlft(a,n)     ((a)<<(n))
193
194 #else /* AFS_64BIT_ENV */
195
196 typedef struct afs_hyper_t {    /* unsigned 64 bit integers */
197     unsigned int high;
198     unsigned int low;
199 } afs_hyper_t;
200
201 #define hcmp(a,b) ((a).high<(b).high? -1 : ((a).high > (b).high? 1 : \
202     ((a).low <(b).low? -1 : ((a).low > (b).low? 1 : 0))))
203 #define hsame(a,b) ((a).low == (b).low && (a).high == (b).high)
204 #define hiszero(a) ((a).low == 0 && (a).high == 0)
205 #define hfitsin32(a) ((a).high == 0)
206 #define hset(a,b) ((a) = (b))
207 #define hzero(a) ((a).low = 0, (a).high = 0)
208 #define hones(a) ((a).low = 0xffffffff, (a).high = 0xffffffff)
209 #define hget32(i,a) ((i) = (a).low)
210 #define hget64(hi,lo,a) ((lo) = (a).low, (hi) = (a).high)
211 #define hset32(a,i) ((a).high = 0, (a).low = (i))
212 #define hset64(a,hi,lo) ((a).high = (hi), (a).low = (lo))
213 #define hgetlo(a) ((a).low)
214 #define hgethi(a) ((a).high)
215 #define hshlft(a,n)                                                        \
216      { /*Shift Left n bits*/                                               \
217         int s = sizeof((a).low) * 8; /*#bits*/                             \
218         if ((n) <= 0) { /*No shift*/                                       \
219         } else if ((n) >= 2*s) { /*Shift off all bits*/                    \
220            (a).high = (a).low = 0;                                         \
221         } else if ((n) < s) { /*Part of low shifted into high*/            \
222            (a).high = ((a).high<<(n)) | (((a).low>>(s-(n))) & (1<<(n))-1); \
223            (a).low  = (a).low << (n);                                      \
224         } else if ((n) >= s) { /*All of low shifted into high plus some*/  \
225            (a).high = (a).low << ((n)-s);                                  \
226            (a).low=0;                                                      \
227         }                                                                  \
228      }
229
230 /* The algorithm here is to check for two cases that cause a carry.  If the top
231  * two bits are different then if the sum has the top bit off then there must
232  * have been a carry.  If the top bits are both one then there is always a
233  * carry.  We assume 32 bit ints and twos complement arithmetic. */
234
235 #define SIGN 0x80000000
236 #define hadd32(a,i) \
237     ((void)((((a).low ^ (int)(i)) & SIGN) \
238       ? (((((a).low + (int)(i)) & SIGN) == 0) && (a).high++) \
239       : (((a).low & (int)(i) & SIGN) && (a).high++)), \
240      (a).low += (int)(i))
241
242 #define hadd(a,b) (hadd32(a,(b).low), (a).high += (b).high)
243 #endif /* AFS_64BIT_ENV */
244
245 #if !defined(KERNEL) || defined(UKERNEL)
246 #ifndef AFS_NT40_ENV
247 #define max(a, b)               ((a) < (b) ? (b) : (a))
248 #define min(a, b)               ((a) > (b) ? (b) : (a))
249 #endif
250 /*#define abs(x)                  ((x) >= 0 ? (x) : -(x))*/
251 #endif
252
253 /* minumum length of string to pass to int_to_base64 */
254 typedef char b64_string_t[8];
255 #ifndef AFS_NT40_ENV
256 #if defined(AFS_HPUX_ENV) || defined(AFS_USR_HPUX_ENV) || (defined(AFS_SUN_ENV) && !defined(AFS_SUN5_ENV))
257 char *int_to_base64();
258 int base64_to_int();
259 #else
260 char *int_to_base64(b64_string_t s, int a);
261 int base64_to_int(char *s);
262 #endif
263 #endif /* AFS_NT40_ENV */
264 /*
265  * The afsUUID data type is built in to RX
266  */
267 struct afsUUID {
268     afs_uint32 time_low;
269     afs_uint16 time_mid;
270     afs_uint16 time_hi_and_version;
271     char clock_seq_hi_and_reserved;
272     char clock_seq_low;
273     char node[6];
274 };
275 typedef struct afsUUID afsUUID;
276
277 /* for now, demand attach fileserver is only support on unix pthreads builds */
278 #if defined(DEMAND_ATTACH_ENABLE) && defined(AFS_PTHREAD_ENV) && !defined(AFS_NT40_ENV)
279 #define AFS_DEMAND_ATTACH_FS 1
280 #endif
281
282 /* A macro that can be used when printf'ing 64 bit integers, as Unix and 
283  * windows use a different format string
284  */
285 #ifdef AFS_NT40_ENV
286 # define AFS_INT64_FMT "I64d"
287 # define AFS_UINT64_FMT "I64u"
288 # define AFS_PTR_FMT   "p"
289 # define AFS_SIZET_FMT "Iu"
290 #else
291 # define AFS_INT64_FMT "lld"
292 # define AFS_UINT64_FMT "llu"
293 # define AFS_PTR_FMT   "p"
294 # ifdef PRINTF_TAKES_Z_LEN
295 #  define AFS_SIZET_FMT "zu"
296 # else
297 #  define AFS_SIZET_FMT "lu"
298 # endif /* PRINTF_TAKES_Z_LEN */
299 #endif /* AFS_NT40_ENV */
300
301 /* Functions to safely cast afs_int32 and afs_uint32 so they can be used in 
302  * printf statemements with %ld and %lu
303  */
304 #ifdef AFS_NT40_ENV
305 #define static_inline __inline static
306 #define hdr_static_inline(x) __inline static x
307 #elif defined(AFS_HPUX_ENV) || defined(AFS_USR_HPUX_ENV)
308 /* The HPUX compiler can segfault on 'static __inline', so fall back to
309  * just 'static' so we can at least compile */
310 #define static_inline static
311 #define hdr_static_inline(x) static x
312 #elif defined(AFS_AIX_ENV) || defined(AFS_USR_AIX_ENV)
313 #define static_inline static
314 #define hdr_static_inline(x) static x
315 #elif defined(AFS_SGI_ENV) || defined(AFS_USR_SGI_ENV)
316 #define static_inline static
317 #define hdr_static_inline(x) x
318 #elif defined(AFS_NBSD_ENV)
319 #define static_inline static __inline __attribute__((always_inline))
320 #define hdr_static_inline(x) static __inline __attribute__((always_inline)) x
321 #else
322 #define static_inline static inline
323 #define hdr_static_inline(x) static inline x
324 #endif
325
326 hdr_static_inline(long) afs_printable_int32_ld(afs_int32 d) { return (long) d; }
327
328 hdr_static_inline(unsigned long) afs_printable_uint32_lu(afs_uint32 d) { return (unsigned long) d; }
329
330 #ifdef AFS_64BITUSERPOINTER_ENV
331 #define afs_pointer_to_int(p)      ((afs_uint32)  (afs_uint64) (p))
332 #define afs_int_to_pointer(i)     ((void *) (afs_uint64) (i))
333 #else
334 #define afs_pointer_to_int(p)      ((afs_uint32)   (p))
335 #define afs_int_to_pointer(i)      ((void *)  (i))
336 #endif
337
338 #if !defined(__GNUC__) || __GNUC__ < 2
339 #define AFS_UNUSED
340 #define AFS_ATTRIBUTE_FORMAT(style,x,y)
341 #else
342 #define AFS_UNUSED __attribute__((unused))
343 #define AFS_ATTRIBUTE_FORMAT(style,x,y) __attribute__((format(style, x, y)))
344 #endif
345
346 #endif /* OPENAFS_CONFIG_AFS_STDS_H */