contrib/tcpdump/parsenfsfh.c

   1 /*
   2  * Copyright (c) 1993, 1994 Jeffrey C. Mogul, Digital Equipment Corporation,
   3  * Western Research Laboratory. All rights reserved.
   4  * Copyright (c) 2001 Compaq Computer Corporation. All rights reserved.
   5  *
   6  *  Permission to use, copy, and modify this software and its
   7  *  documentation is hereby granted only under the following terms and
   8  *  conditions.  Both the above copyright notice and this permission
   9  *  notice must appear in all copies of the software, derivative works
  10  *  or modified versions, and any portions thereof, and both notices
  11  *  must appear in supporting documentation.
  12  *
  13  *  Redistribution and use in source and binary forms, with or without
  14  *  modification, are permitted provided that the following conditions
  15  *  are met:
  16  *    1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  *    2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in
  20  *    the documentation and/or other materials provided with the
  21  *    distribution.
  22  *
  23  *  THE SOFTWARE IS PROVIDED "AS IS" AND COMPAQ COMPUTER CORPORATION
  24  *  DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
  25  *  ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.   IN NO
  26  *  EVENT SHALL COMPAQ COMPUTER CORPORATION BE LIABLE FOR ANY
  27  *  SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  28  *  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  29  *  AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  30  *  OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  31  *  SOFTWARE.
  32  */
  33
  34 /*
  35  * parsenfsfh.c - portable parser for NFS file handles
  36  *                      uses all sorts of heuristics
  37  *
  38  * Jeffrey C. Mogul
  39  * Digital Equipment Corporation
  40  * Western Research Laboratory
  41  *
  42  * $FreeBSD$
  43  */
  44
  45 #ifndef lint
  46 static const char rcsid[] _U_ =
  47     "@(#) $Header: /tcpdump/master/tcpdump/parsenfsfh.c,v 1.28 2004/03/25 03:30:55 mcr Exp $ (LBL)";
  48 #endif
  49
  50 #ifdef HAVE_CONFIG_H
  51 #include "config.h"
  52 #endif
  53
  54 #include <tcpdump-stdinc.h>
  55
  56 #include <stdio.h>
  57 #include <string.h>
  58
  59 #include "interface.h"
  60 #include "nfsfh.h"
  61
  62 /*
  63  * This routine attempts to parse a file handle (in network byte order),
  64  * using heuristics to guess what kind of format it is in.  See the
  65  * file "fhandle_layouts" for a detailed description of the various
  66  * patterns we know about.
  67  *
  68  * The file handle is parsed into our internal representation of a
  69  * file-system id, and an internal representation of an inode-number.
  70  */
  71
  72 #define FHT_UNKNOWN     0
  73 #define FHT_AUSPEX      1
  74 #define FHT_DECOSF      2
  75 #define FHT_IRIX4       3
  76 #define FHT_IRIX5       4
  77 #define FHT_SUNOS3      5
  78 #define FHT_SUNOS4      6
  79 #define FHT_ULTRIX      7
  80 #define FHT_VMSUCX      8
  81 #define FHT_SUNOS5      9
  82 #define FHT_AIX32       10
  83 #define FHT_HPUX9       11
  84
  85 #ifdef  ultrix
  86 /* Nasty hack to keep the Ultrix C compiler from emitting bogus warnings */
  87 #define XFF(x)  ((u_int32_t)(x))
  88 #else
  89 #define XFF(x)  (x)
  90 #endif
  91
  92 #define make_uint32(msb,b,c,lsb)\
  93         (XFF(lsb) + (XFF(c)<<8) + (XFF(b)<<16) + (XFF(msb)<<24))
  94
  95 #define make_uint24(msb,b, lsb)\
  96         (XFF(lsb) + (XFF(b)<<8) + (XFF(msb)<<16))
  97
  98 #define make_uint16(msb,lsb)\
  99         (XFF(lsb) + (XFF(msb)<<8))
 100
 101 #ifdef  __alpha
 102         /* or other 64-bit systems */
 103 #define make_uint48(msb,b,c,d,e,lsb)\
 104         ((lsb) + ((e)<<8) + ((d)<<16) + ((c)<<24) + ((b)<<32) + ((msb)<<40))
 105 #else
 106         /* on 32-bit systems ignore high-order bits */
 107 #define make_uint48(msb,b,c,d,e,lsb)\
 108         ((lsb) + ((e)<<8) + ((d)<<16) + ((c)<<24))
 109 #endif
 110
 111 static int is_UCX(const unsigned char *);
 112
 113 void
 114 Parse_fh(fh, len, fsidp, inop, osnamep, fsnamep, ourself)
 115 register const unsigned char *fh;
 116 int len _U_;
 117 my_fsid *fsidp;
 118 ino_t *inop;
 119 const char **osnamep;           /* if non-NULL, return OS name here */
 120 const char **fsnamep;           /* if non-NULL, return server fs name here (for VMS) */
 121 int ourself;            /* true if file handle was generated on this host */
 122 {
 123         register const unsigned char *fhp = fh;
 124         u_int32_t temp;
 125         int fhtype = FHT_UNKNOWN;
 126         int i;
 127
 128         if (ourself) {
 129             /* File handle generated on this host, no need for guessing */
 130 #if     defined(IRIX40)
 131             fhtype = FHT_IRIX4;
 132 #endif
 133 #if     defined(IRIX50)
 134             fhtype = FHT_IRIX5;
 135 #endif
 136 #if     defined(IRIX51)
 137             fhtype = FHT_IRIX5;
 138 #endif
 139 #if     defined(SUNOS4)
 140             fhtype = FHT_SUNOS4;
 141 #endif
 142 #if     defined(SUNOS5)
 143             fhtype = FHT_SUNOS5;
 144 #endif
 145 #if     defined(ultrix)
 146             fhtype = FHT_ULTRIX;
 147 #endif
 148 #if     defined(__osf__)
 149             fhtype = FHT_DECOSF;
 150 #endif
 151         }
 152         /*
 153          * This is basically a big decision tree
 154          */
 155         else if ((fhp[0] == 0) && (fhp[1] == 0)) {
 156             /* bytes[0,1] == (0,0); rules out Ultrix, IRIX5, SUNOS5 */
 157             /* probably rules out HP-UX, AIX unless they allow major=0 */
 158             if ((fhp[2] == 0) && (fhp[3] == 0)) {
 159                 /* bytes[2,3] == (0,0); must be Auspex */
 160                 /* XXX or could be Ultrix+MASSBUS "hp" disk? */
 161                 fhtype = FHT_AUSPEX;
 162             }
 163             else {
 164                 /*
 165                  * bytes[2,3] != (0,0); rules out Auspex, could be
 166                  * DECOSF, SUNOS4, or IRIX4
 167                  */
 168                 if ((fhp[4] != 0) && (fhp[5] == 0) &&
 169                         (fhp[8] == 12) && (fhp[9] == 0)) {
 170                     /* seems to be DECOSF, with minor == 0 */
 171                     fhtype = FHT_DECOSF;
 172                 }
 173                 else {
 174                     /* could be SUNOS4 or IRIX4 */
 175                     /* XXX the test of fhp[5] == 8 could be wrong */
 176                     if ((fhp[4] == 0) && (fhp[5] == 8) && (fhp[6] == 0) &&
 177                         (fhp[7] == 0)) {
 178                         /* looks like a length, not a file system typecode */
 179                         fhtype = FHT_IRIX4;
 180                     }
 181                     else {
 182                         /* by elimination */
 183                         fhtype = FHT_SUNOS4;
 184                     }
 185                 }
 186             }
 187         }
 188         else {
 189             /*
 190              * bytes[0,1] != (0,0); rules out Auspex, IRIX4, SUNOS4
 191              * could be IRIX5, DECOSF, UCX, Ultrix, SUNOS5
 192              * could be AIX, HP-UX
 193              */
 194             if ((fhp[2] == 0) && (fhp[3] == 0)) {
 195                 /*
 196                  * bytes[2,3] == (0,0); rules out OSF, probably not UCX
 197                  * (unless the exported device name is just one letter!),
 198                  * could be Ultrix, IRIX5, AIX, or SUNOS5
 199                  * might be HP-UX (depends on their values for minor devs)
 200                  */
 201                 /*XXX we probably only need to test of these two bytes */
 202                 if ((fhp[21] == 0) && (fhp[23] == 0)) {
 203                     fhtype = FHT_ULTRIX;
 204                 }
 205                 else {
 206                     /* Could be SUNOS5/IRIX5, maybe AIX */
 207                     /* XXX no obvious difference between SUNOS5 and IRIX5 */
 208                     if (fhp[9] == 10)
 209                         fhtype = FHT_SUNOS5;
 210                     /* XXX what about AIX? */
 211                 }
 212             }
 213             else {
 214                 /*
 215                  * bytes[2,3] != (0,0); rules out Ultrix, could be
 216                  * DECOSF, SUNOS5, IRIX5, AIX, HP-UX, or UCX
 217                  */
 218                 if ((fhp[8] == 12) && (fhp[9] == 0)) {
 219                     fhtype = FHT_DECOSF;
 220                 }
 221                 else if ((fhp[8] == 0) && (fhp[9] == 10)) {
 222                     /* could be SUNOS5/IRIX5, AIX, HP-UX */
 223                     if ((fhp[7] == 0) && (fhp[6] == 0) &&
 224                         (fhp[5] == 0) && (fhp[4] == 0)) {
 225                         /* XXX is this always true of HP-UX? */
 226                         fhtype = FHT_HPUX9;
 227                     }
 228                     else if (fhp[7] == 2) {
 229                         /* This would be MNT_NFS on AIX, which is impossible */
 230                         fhtype = FHT_SUNOS5;    /* or maybe IRIX5 */
 231                     }
 232                     else {
 233                         /*
 234                          * XXX Could be SUNOS5/IRIX5 or AIX.  I don't
 235                          * XXX see any way to disambiguate these, so
 236                          * XXX I'm going with the more likely guess.
 237                          * XXX Sorry, Big Blue.
 238                          */
 239                         fhtype = FHT_SUNOS5;    /* or maybe IRIX5 */
 240                     }
 241                 }
 242                 else {
 243                     if (is_UCX(fhp)) {
 244                         fhtype = FHT_VMSUCX;
 245                     }
 246                     else {
 247                         fhtype = FHT_UNKNOWN;
 248                     }
 249                 }
 250             }
 251         }
 252
 253         /* XXX still needs to handle SUNOS3 */
 254
 255         switch (fhtype) {
 256         case FHT_AUSPEX:
 257             fsidp->Fsid_dev.Minor = fhp[7];
 258             fsidp->Fsid_dev.Major = fhp[6];
 259             fsidp->fsid_code = 0;
 260
 261             temp = make_uint32(fhp[12], fhp[13], fhp[14], fhp[15]);
 262             *inop = temp;
 263
 264             if (osnamep)
 265                 *osnamep = "Auspex";
 266             break;
 267
 268         case FHT_DECOSF:
 269             fsidp->fsid_code = make_uint32(fhp[7], fhp[6], fhp[5], fhp[4]);
 270                         /* XXX could ignore 3 high-order bytes */
 271
 272             temp = make_uint32(fhp[3], fhp[2], fhp[1], fhp[0]);
 273             fsidp->Fsid_dev.Minor = temp & 0xFFFFF;
 274             fsidp->Fsid_dev.Major = (temp>>20) & 0xFFF;
 275
 276             temp = make_uint32(fhp[15], fhp[14], fhp[13], fhp[12]);
 277             *inop = temp;
 278             if (osnamep)
 279                 *osnamep = "OSF";
 280             break;
 281
 282         case FHT_IRIX4:
 283             fsidp->Fsid_dev.Minor = fhp[3];
 284             fsidp->Fsid_dev.Major = fhp[2];
 285             fsidp->fsid_code = 0;
 286
 287             temp = make_uint32(fhp[8], fhp[9], fhp[10], fhp[11]);
 288             *inop = temp;
 289
 290             if (osnamep)
 291                 *osnamep = "IRIX4";
 292             break;
 293
 294         case FHT_IRIX5:
 295             fsidp->Fsid_dev.Minor = make_uint16(fhp[2], fhp[3]);
 296             fsidp->Fsid_dev.Major = make_uint16(fhp[0], fhp[1]);
 297             fsidp->fsid_code = make_uint32(fhp[4], fhp[5], fhp[6], fhp[7]);
 298
 299             temp = make_uint32(fhp[12], fhp[13], fhp[14], fhp[15]);
 300             *inop = temp;
 301
 302             if (osnamep)
 303                 *osnamep = "IRIX5";
 304             break;
 305
 306         case FHT_SUNOS3:
 307             if (osnamep)
 308                 *osnamep = "SUNOS3";
 309             break;
 310
 311         case FHT_SUNOS4:
 312             fsidp->Fsid_dev.Minor = fhp[3];
 313             fsidp->Fsid_dev.Major = fhp[2];
 314             fsidp->fsid_code = make_uint32(fhp[4], fhp[5], fhp[6], fhp[7]);
 315
 316             temp = make_uint32(fhp[12], fhp[13], fhp[14], fhp[15]);
 317             *inop = temp;
 318
 319             if (osnamep)
 320                 *osnamep = "SUNOS4";
 321             break;
 322
 323         case FHT_SUNOS5:
 324             temp = make_uint16(fhp[0], fhp[1]);
 325             fsidp->Fsid_dev.Major = (temp>>2) &  0x3FFF;
 326             temp = make_uint24(fhp[1], fhp[2], fhp[3]);
 327             fsidp->Fsid_dev.Minor = temp & 0x3FFFF;
 328             fsidp->fsid_code = make_uint32(fhp[4], fhp[5], fhp[6], fhp[7]);
 329
 330             temp = make_uint32(fhp[12], fhp[13], fhp[14], fhp[15]);
 331             *inop = temp;
 332
 333             if (osnamep)
 334                 *osnamep = "SUNOS5";
 335             break;
 336
 337         case FHT_ULTRIX:
 338             fsidp->fsid_code = 0;
 339             fsidp->Fsid_dev.Minor = fhp[0];
 340             fsidp->Fsid_dev.Major = fhp[1];
 341
 342             temp = make_uint32(fhp[7], fhp[6], fhp[5], fhp[4]);
 343             *inop = temp;
 344             if (osnamep)
 345                 *osnamep = "Ultrix";
 346             break;
 347
 348         case FHT_VMSUCX:
 349             /* No numeric file system ID, so hash on the device-name */
 350             if (sizeof(*fsidp) >= 14) {
 351                 if (sizeof(*fsidp) > 14)
 352                     memset((char *)fsidp, 0, sizeof(*fsidp));
 353                 /* just use the whole thing */
 354                 memcpy((char *)fsidp, (char *)fh, 14);
 355             }
 356             else {
 357                 u_int32_t tempa[4];     /* at least 16 bytes, maybe more */
 358
 359                 memset((char *)tempa, 0, sizeof(tempa));
 360                 memcpy((char *)tempa, (char *)fh, 14); /* ensure alignment */
 361                 fsidp->Fsid_dev.Minor = tempa[0] + (tempa[1]<<1);
 362                 fsidp->Fsid_dev.Major = tempa[2] + (tempa[3]<<1);
 363                 fsidp->fsid_code = 0;
 364             }
 365
 366             /* VMS file ID is: (RVN, FidHi, FidLo) */
 367             *inop = make_uint32(fhp[26], fhp[27], fhp[23], fhp[22]);
 368
 369             /* Caller must save (and null-terminate?) this value */
 370             if (fsnamep)
 371                 *fsnamep = (char *)&(fhp[1]);
 372
 373             if (osnamep)
 374                 *osnamep = "VMS";
 375             break;
 376
 377         case FHT_AIX32:
 378             fsidp->Fsid_dev.Minor = make_uint16(fhp[2], fhp[3]);
 379             fsidp->Fsid_dev.Major = make_uint16(fhp[0], fhp[1]);
 380             fsidp->fsid_code = make_uint32(fhp[4], fhp[5], fhp[6], fhp[7]);
 381
 382             temp = make_uint32(fhp[12], fhp[13], fhp[14], fhp[15]);
 383             *inop = temp;
 384
 385             if (osnamep)
 386                 *osnamep = "AIX32";
 387             break;
 388
 389         case FHT_HPUX9:
 390             fsidp->Fsid_dev.Major = fhp[0];
 391             temp = make_uint24(fhp[1], fhp[2], fhp[3]);
 392             fsidp->Fsid_dev.Minor = temp;
 393             fsidp->fsid_code = make_uint32(fhp[4], fhp[5], fhp[6], fhp[7]);
 394
 395             temp = make_uint32(fhp[12], fhp[13], fhp[14], fhp[15]);
 396             *inop = temp;
 397
 398             if (osnamep)
 399                 *osnamep = "HPUX9";
 400             break;
 401
 402         case FHT_UNKNOWN:
 403 #ifdef DEBUG
 404             /* XXX debugging */
 405             for (i = 0; i < 32; i++)
 406                 (void)fprintf(stderr, "%x.", fhp[i]);
 407             (void)fprintf(stderr, "\n");
 408 #endif
 409             /* Save the actual handle, so it can be display with -u */
 410             for (i = 0; i < 32; i++)
 411                 (void)snprintf(&(fsidp->Opaque_Handle[i*2]), 3, "%.2X", fhp[i]);
 412
 413             /* XXX for now, give "bogus" values to aid debugging */
 414             fsidp->fsid_code = 0;
 415             fsidp->Fsid_dev.Minor = 257;
 416             fsidp->Fsid_dev.Major = 257;
 417             *inop = 1;
 418
 419             /* display will show this string instead of (257,257) */
 420             if (fsnamep)
 421                 *fsnamep = "Unknown";
 422
 423             if (osnamep)
 424                 *osnamep = "Unknown";
 425             break;
 426
 427         }
 428 }
 429
 430 /*
 431  * Is this a VMS UCX file handle?
 432  *      Check for:
 433  *      (1) leading code byte   [XXX not yet]
 434  *      (2) followed by string of printing chars & spaces
 435  *      (3) followed by string of nulls
 436  */
 437 static int
 438 is_UCX(fhp)
 439 const unsigned char *fhp;
 440 {
 441         register int i;
 442         int seen_null = 0;
 443
 444         for (i = 1; i < 14; i++) {
 445             if (isprint(fhp[i])) {
 446                 if (seen_null)
 447                    return(0);
 448                 else
 449                    continue;
 450             }
 451             else if (fhp[i] == 0) {
 452                 seen_null = 1;
 453                 continue;
 454             }
 455             else
 456                 return(0);
 457         }
 458
 459         return(1);
 460 }