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