cleanup-licensing-and-transarc-references-20030309
[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 typedef short            afs_int16;
48 typedef unsigned short   afs_uint16;
49 #ifdef  AFS_64BIT_ENV
50 typedef int              afs_int32;
51 typedef unsigned int     afs_uint32;
52 typedef long long        afs_int64;
53 typedef  unsigned long long afs_uint64;
54 #define ZeroInt64(a)       (a) = 0
55 #define AssignInt64(a, b)   *(a) = (b)
56 #define AddInt64(a,b,c) *(c) = (a) + (b)
57 #define SubtractInt64(a,b,c) *(c) = (afs_int64)(a) - (afs_int64)(b)
58 #define CompareInt64(a,b) (afs_int64)(a) - (afs_int64)(b)
59 #define NonZeroInt64(a)                (a)
60 #define Int64ToInt32(a)    (a) & 0xFFFFFFFFL
61 #define FillInt64(t,h,l) (t) = (h); (t) <<= 32; (t) |= (l);
62 #define SplitInt64(t,h,l) (h) = (t) >> 32; (l) = (t) & 0xFFFFFFFF;
63 #else   /* AFS_64BIT_ENV */
64 typedef long             afs_int32;
65 typedef unsigned long    afs_uint32;
66
67 struct Int64 {
68     afs_int32 high;
69     afs_uint32 low;
70 };
71 typedef struct Int64 afs_int64;
72
73 struct u_Int64 {
74     afs_uint32 high;
75     afs_uint32 low;
76 };
77 typedef struct u_Int64 afs_uint64;
78 #define ZeroInt64(a) (a).high = (a).low = 0
79 #define AssignInt64(a, b) (b)->high = (a).high; (b)->low = (a).low
80 #define NonZeroInt64(a)   (a).low || (a).high
81 #define Int64ToInt32(a)    (a).low
82 #define FillInt64(t,h,l) (t).high = (h); (t).low = (l);
83 #define SplitInt64(t,h,l) (h) = (t).high; (l) = (t).low;
84 #endif  /* AFS_64BIT_ENV */
85
86 /* AFS_64BIT_CLIENT should presently be set only for AFS_64BIT_ENV systems */
87
88 #ifdef AFS_64BIT_CLIENT
89 typedef afs_int64 afs_size_t;
90 typedef afs_uint64 afs_offs_t;
91 #define SplitOffsetOrSize(t,h,l) SplitInt64(t,h,l)
92 #else /* AFS_64BIT_CLIENT */
93 typedef afs_int32 afs_size_t;
94 typedef afs_uint32 afs_offs_t;
95 #define SplitOffsetOrSize(t,h,l) (h) = 0; (l) = (t);
96 #endif /* AFS_64BIT_CLIENT */
97
98 /* you still have to include <netinet/in.h> to make these work */
99
100 #define hton32 htonl
101 #define hton16 htons
102 #define ntoh32 ntohl
103 #define ntoh16 ntohs
104
105
106 /* Since there is going to be considerable use of 64 bit integers we provide
107  * some assistence in this matter.  The hyper type is supposed to be compatible
108  * with the afsHyper type: the same macros will work on both. */
109
110 #if     defined(AFS_64BIT_ENV) && 0
111
112 typedef unsigned long   afs_hyper_t;
113
114 #define hcmp(a,b)       ((a) < (b) ? -1 : ((a) > (b) ? 1 : 0))
115 #define hsame(a,b)      ((a) == (b))
116 #define hiszero(a)      ((a) == 0)
117 #define hfitsin32(a)    ((a) & 0xffffffff00000000) == 0)
118 #define hset(a,b)       ((a) = (b))
119 #define hzero(a)        ((a) = 0)
120 #define hones(a)        ((a) = ~((unsigned long)0))
121 #define hget32(i,a)     ((i) = (unsigned int)(a))
122 #define hget64(hi,lo,a) ((lo) = ((unsigned int)(a)), (hi) = ((a) & (0xffffffff00000000)))
123 #define hset32(a,i)     ((a) = ((unsigned int)(i)))
124 #define hset64(a,hi,lo) ((a) = (((hi) << 32) | (lo)))
125 #define hgetlo(a)       ((a) & 0xffffffff)
126 #define hgethi(a)       (((unsigned int)(a)) >> 32)
127 #define hadd(a,b)       ((a) += (b))
128 /* XXX */
129 #define hadd32(a,b)     ((a) += (b))
130 #define hshlft(a,n)     ((a)<<(n))
131
132 #else   /* AFS_64BIT_ENV */
133
134 typedef struct afs_hyper_t { /* unsigned 64 bit integers */
135     unsigned int high;
136     unsigned int low;
137 } afs_hyper_t;
138
139 #define hcmp(a,b) ((a).high<(b).high? -1 : ((a).high > (b).high? 1 : \
140     ((a).low <(b).low? -1 : ((a).low > (b).low? 1 : 0))))
141 #define hsame(a,b) ((a).low == (b).low && (a).high == (b).high)
142 #define hiszero(a) ((a).low == 0 && (a).high == 0)
143 #define hfitsin32(a) ((a).high == 0)
144 #define hset(a,b) ((a) = (b))
145 #define hzero(a) ((a).low = 0, (a).high = 0)
146 #define hones(a) ((a).low = 0xffffffff, (a).high = 0xffffffff)
147 #define hget32(i,a) ((i) = (a).low)
148 #define hget64(hi,lo,a) ((lo) = (a).low, (hi) = (a).high)
149 #define hset32(a,i) ((a).high = 0, (a).low = (i))
150 #define hset64(a,hi,lo) ((a).high = (hi), (a).low = (lo))
151 #define hgetlo(a) ((a).low)
152 #define hgethi(a) ((a).high)
153 #define hshlft(a,n)                                                        \
154      { /*Shift Left n bits*/                                               \
155         int s = sizeof((a).low) * 8; /*#bits*/                             \
156         if ((n) <= 0) { /*No shift*/                                       \
157         } else if ((n) >= 2*s) { /*Shift off all bits*/                    \
158            (a).high = (a).low = 0;                                         \
159         } else if ((n) < s) { /*Part of low shifted into high*/            \
160            (a).high = ((a).high<<(n)) | (((a).low>>(s-(n))) & (1<<(n))-1); \
161            (a).low  = (a).low << (n);                                      \
162         } else if ((n) >= s) { /*All of low shifted into high plus some*/  \
163            (a).high = (a).low << ((n)-s);                                  \
164            (a).low=0;                                                      \
165         }                                                                  \
166      }
167
168 /* The algorithm here is to check for two cases that cause a carry.  If the top
169  * two bits are different then if the sum has the top bit off then there must
170  * have been a carry.  If the top bits are both one then there is always a
171  * carry.  We assume 32 bit ints and twos complement arithmetic. */
172
173 #define SIGN 0x80000000
174 #define hadd32(a,i) \
175     (((((a).low ^ (int)(i)) & SIGN) \
176       ? (((((a).low + (int)(i)) & SIGN) == 0) && (a).high++) \
177       : (((a).low & (int)(i) & SIGN) && (a).high++)), \
178      (a).low += (int)(i))
179
180 #define hadd(a,b) (hadd32(a,(b).low), (a).high += (b).high)
181 #endif  /* AFS_64BIT_ENV */
182
183 #ifndef KERNEL
184 #ifndef AFS_NT40_ENV
185 #define max(a, b)               ((a) < (b) ? (b) : (a))
186 #define min(a, b)               ((a) > (b) ? (b) : (a))
187 #endif
188 /*#define abs(x)                  ((x) >= 0 ? (x) : -(x))*/
189 #endif
190
191 /* minumum length of string to pass to int_to_base64 */
192 typedef char b64_string_t[8];
193 #if defined(AFS_HPUX_ENV) || defined(AFS_USR_HPUX_ENV) || (defined(AFS_SUN_ENV) && !defined(AFS_SUN5_ENV))
194 char *int_to_base64();
195 int base64_to_int();
196 #else
197 char *int_to_base64(b64_string_t s, int a);
198 int base64_to_int(char *s);
199 #endif
200
201 /*
202  * The afsUUID data type is built in to RX
203  */
204 struct afsUUID {
205     afs_uint32 time_low;
206     afs_uint16 time_mid;
207     afs_uint16 time_hi_and_version;
208     char clock_seq_hi_and_reserved;
209     char clock_seq_low;
210     char node[6];
211 };
212 typedef struct afsUUID afsUUID;
213
214 #endif /* OPENAFS_CONFIG_AFS_STDS_H */