libafs: remove extraneous solaris headers from afs_util.c
[openafs.git] / src / afs / afs_util.c
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 /*
11  * afs_util.c - miscellaneous AFS client utility functions
12  *
13  * Implements:
14  */
15 #include <afsconfig.h>
16 #include "afs/param.h"
17
18
19 #include "afs/stds.h"
20 #include "afs/sysincludes.h"    /* Standard vendor system headers */
21
22 #if !defined(UKERNEL)
23 #if !defined(AFS_LINUX20_ENV)
24 #include <net/if.h>
25 #endif
26 #include <netinet/in.h>
27
28 #ifdef AFS_SGI62_ENV
29 #include "h/hashing.h"
30 #endif
31 #if !defined(AFS_HPUX110_ENV) && !defined(AFS_LINUX20_ENV) && !defined(AFS_DARWIN_ENV)
32 #include <netinet/in_var.h>
33 #endif /* ! AFS_HPUX110_ENV */
34 #endif /* !defined(UKERNEL) */
35
36 #include "afsincludes.h"        /* Afs-based standard headers */
37 #include "afs/afs_stats.h"      /* afs statistics */
38
39 #ifdef AFS_LINUX20_ENV
40 #include "hcrypto/md5.h"
41 #endif
42
43 #if     defined(AFS_AIX_ENV)
44 #include <sys/fp_io.h>
45 #endif
46
47 afs_int32 afs_new_inum = 0;
48
49 #ifndef afs_cv2string
50 char *
51 afs_cv2string(char *ttp, afs_uint32 aval)
52 {
53     char *tp = ttp;
54     int i;
55     int any;
56
57     AFS_STATCNT(afs_cv2string);
58     any = 0;
59     *(--tp) = 0;
60     while (aval != 0) {
61         i = aval % 10;
62         *(--tp) = '0' + i;
63         aval /= 10;
64         any = 1;
65     }
66     if (!any)
67         *(--tp) = '0';
68     return tp;
69
70 }                               /*afs_cv2string */
71 #endif
72
73 /* not a generic strtoul replacement. for vol/vno/uniq, portable */
74
75 afs_int32
76 afs_strtoi_r(const char *str, char **endptr, afs_uint32 *ret)
77 {
78     char *x;
79
80     *ret = 0;
81     *endptr = (char *)str;
82
83     if (!str)
84         return ERANGE;
85
86     for (x = (char *)str; *x >= '0' && *x <= '9'; x++) {
87         /* Check for impending overflow */
88         if (*ret > 429496729) { /* ULONG_MAX/10 */
89             *ret = 0;
90             *endptr = (char *)str;
91             return EINVAL;
92         }
93
94         *ret = (*ret * 10) + (*x - '0');
95     }
96
97     *endptr = x;
98     return 0;
99 }
100
101 #ifndef afs_strcasecmp
102 int
103 afs_strcasecmp(const char *s1, const char *s2)
104 {
105     while (*s1 && *s2) {
106         char c1, c2;
107
108         c1 = *s1++;
109         c2 = *s2++;
110         if (c1 >= 'A' && c1 <= 'Z')
111             c1 += 0x20;
112         if (c2 >= 'A' && c2 <= 'Z')
113             c2 += 0x20;
114         if (c1 != c2)
115             return c1 - c2;
116     }
117
118     return *s1 - *s2;
119 }
120 #endif
121
122 #ifndef afs_strcat
123 char *
124 afs_strcat(char *s1, char *s2)
125 {
126     char *os1;
127
128     os1 = s1;
129     while (*s1++);
130     --s1;
131     while ((*s1++ = *s2++));
132     return (os1);
133 }
134 #endif
135
136 #ifdef AFS_OBSD34_ENV
137 char *
138 afs_strcpy(char *s1, char *s2)
139 {
140     char *os1;
141
142     os1 = s1;
143     while ((*s1++ = *s2++) != '\0');
144     return os1;
145 }
146 #endif
147
148 #ifndef afs_strchr
149 char *
150 afs_strchr(char *s, int c)
151 {
152     char *p;
153
154     for (p = s; *p; p++)
155         if (*p == c)
156             return p;
157     return NULL;
158 }
159 #endif
160 #ifndef afs_strrchr
161 char *
162 afs_strrchr(char *s, int c)
163 {
164     char *p = NULL;
165
166     do {
167         if (*s == c)
168             p = (char*) s;
169     } while (*s++);
170     return p;
171 }
172 #endif
173
174 char *
175 afs_strdup(char *s)
176 {
177     char *n;
178     int cc;
179
180     cc = strlen(s) + 1;
181     n = afs_osi_Alloc(cc);
182     if (n)
183         memcpy(n, s, cc);
184
185     return n;
186 }
187
188 void
189 print_internet_address(char *preamble, struct srvAddr *sa, char *postamble,
190                        int flag, int code, struct rx_connection *rxconn)
191 {
192     struct server *aserver = sa->server;
193     char *ptr = "\n";
194     afs_uint32 address;
195
196     AFS_STATCNT(print_internet_address);
197     address = ntohl(sa->sa_ip);
198     if (aserver->flags & SRVR_MULTIHOMED) {
199         if (flag == 1) {        /* server down mesg */
200             if (!(aserver->flags & SRVR_ISDOWN))
201                 ptr =
202                     " (multi-homed address; other same-host interfaces maybe up)\n";
203             else
204                 ptr = " (all multi-homed ip addresses down for the server)\n";
205         } else if (flag == 2) { /* server up mesg */
206             ptr =
207                 " (multi-homed address; other same-host interfaces may still be down)\n";
208         }
209     }
210     afs_warnall("%s%d.%d.%d.%d in cell %s%s (code %d)%s", preamble, (address >> 24),
211              (address >> 16) & 0xff, (address >> 8) & 0xff, (address) & 0xff,
212              aserver->cell->cellName, postamble, code, ptr);
213
214     if (flag == 1 && rxconn) {
215         /* server was marked down, check Rx to see if this was possibly due to
216          * an ICMP error received from the network */
217         int errorigin, errtype, errcode;
218         const char *errmsg;
219         if (rx_GetNetworkError(rxconn, &errorigin, &errtype, &errcode, &errmsg) == 0) {
220             const char *str1 = " (";
221             const char *str2 = ")";
222             if (!errmsg) {
223                 errmsg = str1 = str2 = "";
224             }
225             afs_warnall("afs: network error for %d.%d.%d.%d:%d: origin %d type %d code %d%s%s%s\n",
226                      (address >> 24),
227                      (address >> 16) & 0xff,
228                      (address >> 8) & 0xff,
229                      (address) & 0xff,
230                      (int)ntohs(sa->sa_portal),
231                      errorigin, errtype, errcode, str1, errmsg, str2);
232         }
233     }
234 }                               /*print_internet_address */
235
236
237
238 /* run everywhere, checking locks */
239 void
240 afs_CheckLocks(void)
241 {
242     int i;
243
244     afs_warn("Looking for locked data structures.\n");
245     afs_warn("conn %p, volume %p, user %p, cell %p, server %p\n", &afs_xconn,
246              &afs_xvolume, &afs_xuser, &afs_xcell, &afs_xserver);
247     {
248         struct vcache *tvc;
249         AFS_STATCNT(afs_CheckLocks);
250
251         for (i = 0; i < VCSIZE; i++) {
252             for (tvc = afs_vhashT[i]; tvc; tvc = tvc->hnext) {
253                 if (tvc->f.states & CVInit) continue;
254 #ifdef AFS_DARWIN80_ENV
255                 if (vnode_isinuse(AFSTOV(tvc), 0))
256 #else
257                 if (VREFCOUNT(tvc))
258 #endif
259                     afs_warn("Stat cache entry at %p is held\n", tvc);
260                 if (CheckLock(&tvc->lock))
261                     afs_warn("Stat entry at %p is locked\n", tvc);
262             }
263         }
264     }
265     {
266         struct dcache *tdc;
267         for (i = 0; i < afs_cacheFiles; i++) {
268             tdc = afs_indexTable[i];
269             if (tdc) {
270                 if (tdc->refCount)
271                     afs_warn("Disk entry %d at %p is held\n", i, tdc);
272             }
273             if (afs_indexFlags[i] & IFDataMod)
274                 afs_warn("Disk entry %d at %p has IFDataMod flag set.\n", i,
275                          tdc);
276         }
277     }
278     {
279         struct srvAddr *sa;
280         struct server *ts;
281         struct sa_conn_vector *tcv;
282         for (i = 0; i < NSERVERS; i++) {
283             for (ts = afs_servers[i]; ts; ts = ts->next) {
284                 if (ts->flags & SRVR_ISDOWN)
285                     afs_warn("Server entry %p is marked down\n", ts);
286                 for (sa = ts->addr; sa; sa = sa->next_sa) {
287                     for (tcv = sa->conns; tcv; tcv = tcv->next) {
288                         if (tcv->refCount)
289                             afs_warn("conn at %p (server %x) is held\n", tcv,
290                                      sa->sa_ip);
291                     }
292                 }
293             }
294         }
295     }
296     {
297         struct volume *tv;
298         for (i = 0; i < NVOLS; i++) {
299             for (tv = afs_volumes[i]; tv; tv = tv->next) {
300                 if (CheckLock(&tv->lock))
301                     afs_warn("volume at %p is locked\n", tv);
302                 if (tv->refCount)
303                     afs_warn("volume at %p is held\n", tv);
304             }
305         }
306     }
307     {
308         struct unixuser *tu;
309
310         for (i = 0; i < NUSERS; i++) {
311             for (tu = afs_users[i]; tu; tu = tu->next) {
312                 if (CheckLock(&tu->lock))
313                     afs_warn("user at %p is locked\n", tu);
314                 if (tu->refCount)
315                     afs_warn("user at %lx is held\n", (unsigned long)tu);
316             }
317         }
318     }
319     afs_warn("Done.\n");
320 }
321
322
323 int
324 afs_noop(void)
325 {
326     AFS_STATCNT(afs_noop);
327     return EINVAL;
328 }
329
330 int
331 afs_badop(void)
332 {
333     AFS_STATCNT(afs_badop);
334     osi_Panic("afs bad vnode op");
335     return 0;
336 }
337
338 /*
339  * afs_data_pointer_to_int32() - returns least significant afs_int32 of the
340  * given data pointer, without triggering "cast truncates pointer"
341  * warnings.  We use this where we explicitly don't care whether a
342  * pointer is truncated -- it loses information where a pointer is
343  * larger than an afs_int32.
344  */
345
346 afs_int32
347 afs_data_pointer_to_int32(const void *p)
348 {
349     union {
350         afs_int32 i32[sizeof(void *) / sizeof(afs_int32)];
351         const void *p;
352     } ip;
353
354     int i32_sub;                /* subscript of least significant afs_int32 in ip.i32[] */
355
356     /* set i32_sub */
357
358     {
359         /* used to determine the byte order of the system */
360
361         union {
362             char c[sizeof(int) / sizeof(char)];
363             int i;
364         } ci;
365
366         ci.i = 1;
367         if (ci.c[0] == 1) {
368             /* little-endian system */
369             i32_sub = 0;
370         } else {
371             /* big-endian system */
372             i32_sub = (sizeof ip.i32 / sizeof ip.i32[0]) - 1;
373         }
374     }
375
376     ip.p = p;
377     return ip.i32[i32_sub];
378 }
379
380 #ifdef AFS_LINUX20_ENV
381 static_inline afs_int32
382 afs_calc_inum_md5(afs_int32 cell, afs_int32 volume, afs_int32 vnode)
383 {
384     afs_int32 ino = 0, vno = vnode;
385     char digest[16];
386     struct md5 ct;
387
388     if (afs_new_inum) {
389         int offset;
390         MD5_Init(&ct);
391         MD5_Update(&ct, &cell, 4);
392         MD5_Update(&ct, &volume, 4);
393         MD5_Update(&ct, &vnode, 4);
394         MD5_Final(digest, &ct);
395
396         /* Userspace may react oddly to an inode number of 0 or 1, so keep
397          * reading more of the md5 digest if we get back one of those.
398          * Make sure not to read beyond the end of the digest; if we somehow
399          * still have a 0, we will fall through to the non-md5 calculation. */
400         for (offset = 0;
401              (ino == 0 || ino == 1) &&
402               offset + sizeof(ino) <= sizeof(digest);
403              offset++) {
404
405             memcpy(&ino, &digest[offset], sizeof(ino));
406             ino ^= (ino ^ vno) & 1;
407             ino &= 0x7fffffff;      /* Assumes 32 bit ino_t ..... */
408         }
409     }
410     return ino;
411 }
412 #else
413 # define afs_calc_inum_md5(cell, volume, vnode) 0
414 #endif
415
416 afs_int32
417 afs_calc_inum(afs_int32 cell, afs_int32 volume, afs_int32 vnode)
418 {
419     afs_int32 ino;
420
421     ino = afs_calc_inum_md5(cell, volume, vnode);
422
423     if (ino == 0 || ino == 1) {
424         ino = (volume << 16) + vnode;
425     }
426     ino &= 0x7fffffff;      /* Assumes 32 bit ino_t ..... */
427     return ino;
428 }