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)
 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 }                               /*print_internet_address */
 225
 226
 227
 228 /* run everywhere, checking locks */
 229 void
 230 afs_CheckLocks(void)
 231 {
 232     int i;
 233
 234     afs_warn("Looking for locked data structures.\n");
 235     afs_warn("conn %p, volume %p, user %p, cell %p, server %p\n", &afs_xconn,
 236              &afs_xvolume, &afs_xuser, &afs_xcell, &afs_xserver);
 237     {
 238         struct vcache *tvc;
 239         AFS_STATCNT(afs_CheckLocks);
 240
 241         for (i = 0; i < VCSIZE; i++) {
 242             for (tvc = afs_vhashT[i]; tvc; tvc = tvc->hnext) {
 243                 if (tvc->f.states & CVInit) continue;
 244 #ifdef AFS_DARWIN80_ENV
 245                 if (vnode_isinuse(AFSTOV(tvc), 0))
 246 #else
 247                 if (VREFCOUNT(tvc))
 248 #endif
 249                     afs_warn("Stat cache entry at %p is held\n", tvc);
 250                 if (CheckLock(&tvc->lock))
 251                     afs_warn("Stat entry at %p is locked\n", tvc);
 252             }
 253         }
 254     }
 255     {
 256         struct dcache *tdc;
 257         for (i = 0; i < afs_cacheFiles; i++) {
 258             tdc = afs_indexTable[i];
 259             if (tdc) {
 260                 if (tdc->refCount)
 261                     afs_warn("Disk entry %d at %p is held\n", i, tdc);
 262             }
 263             if (afs_indexFlags[i] & IFDataMod)
 264                 afs_warn("Disk entry %d at %p has IFDataMod flag set.\n", i,
 265                          tdc);
 266         }
 267     }
 268     {
 269         struct srvAddr *sa;
 270         struct server *ts;
 271         struct sa_conn_vector *tcv;
 272         for (i = 0; i < NSERVERS; i++) {
 273             for (ts = afs_servers[i]; ts; ts = ts->next) {
 274                 if (ts->flags & SRVR_ISDOWN)
 275                     afs_warn("Server entry %p is marked down\n", ts);
 276                 for (sa = ts->addr; sa; sa = sa->next_sa) {
 277                     for (tcv = sa->conns; tcv; tcv = tcv->next) {
 278                         if (tcv->refCount)
 279                             afs_warn("conn at %p (server %x) is held\n", tcv,
 280                                      sa->sa_ip);
 281                     }
 282                 }
 283             }
 284         }
 285     }
 286     {
 287         struct volume *tv;
 288         for (i = 0; i < NVOLS; i++) {
 289             for (tv = afs_volumes[i]; tv; tv = tv->next) {
 290                 if (CheckLock(&tv->lock))
 291                     afs_warn("volume at %p is locked\n", tv);
 292                 if (tv->refCount)
 293                     afs_warn("volume at %p is held\n", tv);
 294             }
 295         }
 296     }
 297     {
 298         struct unixuser *tu;
 299
 300         for (i = 0; i < NUSERS; i++) {
 301             for (tu = afs_users[i]; tu; tu = tu->next) {
 302                 if (CheckLock(&tu->lock))
 303                     afs_warn("user at %p is locked\n", tu);
 304                 if (tu->refCount)
 305                     afs_warn("user at %lx is held\n", (unsigned long)tu);
 306             }
 307         }
 308     }
 309     afs_warn("Done.\n");
 310 }
 311
 312
 313 int
 314 afs_noop(void)
 315 {
 316     AFS_STATCNT(afs_noop);
 317     return EINVAL;
 318 }
 319
 320 int
 321 afs_badop(void)
 322 {
 323     AFS_STATCNT(afs_badop);
 324     osi_Panic("afs bad vnode op");
 325     return 0;
 326 }
 327
 328 /*
 329  * afs_data_pointer_to_int32() - returns least significant afs_int32 of the
 330  * given data pointer, without triggering "cast truncates pointer"
 331  * warnings.  We use this where we explicitly don't care whether a
 332  * pointer is truncated -- it loses information where a pointer is
 333  * larger than an afs_int32.
 334  */
 335
 336 afs_int32
 337 afs_data_pointer_to_int32(const void *p)
 338 {
 339     union {
 340         afs_int32 i32[sizeof(void *) / sizeof(afs_int32)];
 341         const void *p;
 342     } ip;
 343
 344     int i32_sub;                /* subscript of least significant afs_int32 in ip.i32[] */
 345
 346     /* set i32_sub */
 347
 348     {
 349         /* used to determine the byte order of the system */
 350
 351         union {
 352             char c[sizeof(int) / sizeof(char)];
 353             int i;
 354         } ci;
 355
 356         ci.i = 1;
 357         if (ci.c[0] == 1) {
 358             /* little-endian system */
 359             i32_sub = 0;
 360         } else {
 361             /* big-endian system */
 362             i32_sub = (sizeof ip.i32 / sizeof ip.i32[0]) - 1;
 363         }
 364     }
 365
 366     ip.p = p;
 367     return ip.i32[i32_sub];
 368 }
 369
 370 #ifdef AFS_LINUX20_ENV
 371 static_inline afs_int32
 372 afs_calc_inum_md5(afs_int32 cell, afs_int32 volume, afs_int32 vnode)
 373 {
 374     afs_int32 ino = 0, vno = vnode;
 375     char digest[16];
 376     struct md5 ct;
 377
 378     if (afs_new_inum) {
 379         int offset;
 380         MD5_Init(&ct);
 381         MD5_Update(&ct, &cell, 4);
 382         MD5_Update(&ct, &volume, 4);
 383         MD5_Update(&ct, &vnode, 4);
 384         MD5_Final(digest, &ct);
 385
 386         /* Userspace may react oddly to an inode number of 0 or 1, so keep
 387          * reading more of the md5 digest if we get back one of those.
 388          * Make sure not to read beyond the end of the digest; if we somehow
 389          * still have a 0, we will fall through to the non-md5 calculation. */
 390         for (offset = 0;
 391              (ino == 0 || ino == 1) &&
 392               offset + sizeof(ino) <= sizeof(digest);
 393              offset++) {
 394
 395             memcpy(&ino, &digest[offset], sizeof(ino));
 396             ino ^= (ino ^ vno) & 1;
 397             ino &= 0x7fffffff;      /* Assumes 32 bit ino_t ..... */
 398         }
 399     }
 400     return ino;
 401 }
 402 #else
 403 # define afs_calc_inum_md5(cell, volume, vnode) 0
 404 #endif
 405
 406 afs_int32
 407 afs_calc_inum(afs_int32 cell, afs_int32 volume, afs_int32 vnode)
 408 {
 409     afs_int32 ino;
 410
 411     ino = afs_calc_inum_md5(cell, volume, vnode);
 412
 413     if (ino == 0 || ino == 1) {
 414         ino = (volume << 16) + vnode;
 415     }
 416     ino &= 0x7fffffff;      /* Assumes 32 bit ino_t ..... */
 417     return ino;
 418 }