dist/tcpdump/nfs.h

   1 /*      $NetBSD$        */
   2
   3 /* @(#) Header: /tcpdump/master/tcpdump/nfs.h,v 1.7 2002/12/11 07:13:55 guy Exp (LBL) */
   4 /*      NetBSD: nfs.h,v 1.1 1996/05/23 22:49:53 fvdl Exp        */
   5
   6 /*
   7  * Copyright (c) 1989, 1993
   8  *      The Regents of the University of California.  All rights reserved.
   9  *
  10  * This code is derived from software contributed to Berkeley by
  11  * Rick Macklem at The University of Guelph.
  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 the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  *      @(#)nfsproto.h  8.2 (Berkeley) 3/30/95
  38  */
  39
  40 /*
  41  * nfs definitions as per the Version 2 and 3 specs
  42  */
  43
  44 /*
  45  * Constants as defined in the Sun NFS Version 2 and 3 specs.
  46  * "NFS: Network File System Protocol Specification" RFC1094
  47  * and in the "NFS: Network File System Version 3 Protocol
  48  * Specification"
  49  */
  50
  51 #define NFS_PORT        2049
  52 #define NFS_PROG        100003
  53 #define NFS_VER2        2
  54 #define NFS_VER3        3
  55 #define NFS_V2MAXDATA   8192
  56 #define NFS_MAXDGRAMDATA 16384
  57 #define NFS_MAXDATA     32768
  58 #define NFS_MAXPATHLEN  1024
  59 #define NFS_MAXNAMLEN   255
  60 #define NFS_MAXPKTHDR   404
  61 #define NFS_MAXPACKET   (NFS_MAXPKTHDR + NFS_MAXDATA)
  62 #define NFS_MINPACKET   20
  63 #define NFS_FABLKSIZE   512     /* Size in bytes of a block wrt fa_blocks */
  64
  65 /* Stat numbers for rpc returns (version 2 and 3) */
  66 #define NFS_OK                  0
  67 #define NFSERR_PERM             1
  68 #define NFSERR_NOENT            2
  69 #define NFSERR_IO               5
  70 #define NFSERR_NXIO             6
  71 #define NFSERR_ACCES            13
  72 #define NFSERR_EXIST            17
  73 #define NFSERR_XDEV             18      /* Version 3 only */
  74 #define NFSERR_NODEV            19
  75 #define NFSERR_NOTDIR           20
  76 #define NFSERR_ISDIR            21
  77 #define NFSERR_INVAL            22      /* Version 3 only */
  78 #define NFSERR_FBIG             27
  79 #define NFSERR_NOSPC            28
  80 #define NFSERR_ROFS             30
  81 #define NFSERR_MLINK            31      /* Version 3 only */
  82 #define NFSERR_NAMETOL          63
  83 #define NFSERR_NOTEMPTY         66
  84 #define NFSERR_DQUOT            69
  85 #define NFSERR_STALE            70
  86 #define NFSERR_REMOTE           71      /* Version 3 only */
  87 #define NFSERR_WFLUSH           99      /* Version 2 only */
  88 #define NFSERR_BADHANDLE        10001   /* The rest Version 3 only */
  89 #define NFSERR_NOT_SYNC         10002
  90 #define NFSERR_BAD_COOKIE       10003
  91 #define NFSERR_NOTSUPP          10004
  92 #define NFSERR_TOOSMALL         10005
  93 #define NFSERR_SERVERFAULT      10006
  94 #define NFSERR_BADTYPE          10007
  95 #define NFSERR_JUKEBOX          10008
  96 #define NFSERR_TRYLATER         NFSERR_JUKEBOX
  97 #define NFSERR_STALEWRITEVERF   30001   /* Fake return for nfs_commit() */
  98
  99 #define NFSERR_RETVOID          0x20000000 /* Return void, not error */
 100 #define NFSERR_AUTHERR          0x40000000 /* Mark an authentication error */
 101 #define NFSERR_RETERR           0x80000000 /* Mark an error return for V3 */
 102
 103 /* Sizes in bytes of various nfs rpc components */
 104 #define NFSX_UNSIGNED   4
 105
 106 /* specific to NFS Version 2 */
 107 #define NFSX_V2FH       32
 108 #define NFSX_V2FATTR    68
 109 #define NFSX_V2SATTR    32
 110 #define NFSX_V2COOKIE   4
 111 #define NFSX_V2STATFS   20
 112
 113 /* specific to NFS Version 3 */
 114 #if 0
 115 #define NFSX_V3FH               (sizeof (fhandle_t)) /* size this server uses */
 116 #endif
 117 #define NFSX_V3FHMAX            64      /* max. allowed by protocol */
 118 #define NFSX_V3FATTR            84
 119 #define NFSX_V3SATTR            60      /* max. all fields filled in */
 120 #define NFSX_V3SRVSATTR         (sizeof (struct nfsv3_sattr))
 121 #define NFSX_V3POSTOPATTR       (NFSX_V3FATTR + NFSX_UNSIGNED)
 122 #define NFSX_V3WCCDATA          (NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
 123 #define NFSX_V3COOKIEVERF       8
 124 #define NFSX_V3WRITEVERF        8
 125 #define NFSX_V3CREATEVERF       8
 126 #define NFSX_V3STATFS           52
 127 #define NFSX_V3FSINFO           48
 128 #define NFSX_V3PATHCONF         24
 129
 130 /* variants for both versions */
 131 #define NFSX_FH(v3)             ((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \
 132                                         NFSX_V2FH)
 133 #define NFSX_SRVFH(v3)          ((v3) ? NFSX_V3FH : NFSX_V2FH)
 134 #define NFSX_FATTR(v3)          ((v3) ? NFSX_V3FATTR : NFSX_V2FATTR)
 135 #define NFSX_PREOPATTR(v3)      ((v3) ? (7 * NFSX_UNSIGNED) : 0)
 136 #define NFSX_POSTOPATTR(v3)     ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0)
 137 #define NFSX_POSTOPORFATTR(v3)  ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \
 138                                         NFSX_V2FATTR)
 139 #define NFSX_WCCDATA(v3)        ((v3) ? NFSX_V3WCCDATA : 0)
 140 #define NFSX_WCCORFATTR(v3)     ((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR)
 141 #define NFSX_SATTR(v3)          ((v3) ? NFSX_V3SATTR : NFSX_V2SATTR)
 142 #define NFSX_COOKIEVERF(v3)     ((v3) ? NFSX_V3COOKIEVERF : 0)
 143 #define NFSX_WRITEVERF(v3)      ((v3) ? NFSX_V3WRITEVERF : 0)
 144 #define NFSX_READDIR(v3)        ((v3) ? (5 * NFSX_UNSIGNED) : \
 145                                         (2 * NFSX_UNSIGNED))
 146 #define NFSX_STATFS(v3)         ((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
 147
 148 /* nfs rpc procedure numbers (before version mapping) */
 149 #define NFSPROC_NULL            0
 150 #define NFSPROC_GETATTR         1
 151 #define NFSPROC_SETATTR         2
 152 #define NFSPROC_LOOKUP          3
 153 #define NFSPROC_ACCESS          4
 154 #define NFSPROC_READLINK        5
 155 #define NFSPROC_READ            6
 156 #define NFSPROC_WRITE           7
 157 #define NFSPROC_CREATE          8
 158 #define NFSPROC_MKDIR           9
 159 #define NFSPROC_SYMLINK         10
 160 #define NFSPROC_MKNOD           11
 161 #define NFSPROC_REMOVE          12
 162 #define NFSPROC_RMDIR           13
 163 #define NFSPROC_RENAME          14
 164 #define NFSPROC_LINK            15
 165 #define NFSPROC_READDIR         16
 166 #define NFSPROC_READDIRPLUS     17
 167 #define NFSPROC_FSSTAT          18
 168 #define NFSPROC_FSINFO          19
 169 #define NFSPROC_PATHCONF        20
 170 #define NFSPROC_COMMIT          21
 171
 172 /* And leasing (nqnfs) procedure numbers (must be last) */
 173 #define NQNFSPROC_GETLEASE      22
 174 #define NQNFSPROC_VACATED       23
 175 #define NQNFSPROC_EVICTED       24
 176
 177 #define NFSPROC_NOOP            25
 178 #define NFS_NPROCS              26
 179
 180 /* Actual Version 2 procedure numbers */
 181 #define NFSV2PROC_NULL          0
 182 #define NFSV2PROC_GETATTR       1
 183 #define NFSV2PROC_SETATTR       2
 184 #define NFSV2PROC_NOOP          3
 185 #define NFSV2PROC_ROOT          NFSV2PROC_NOOP  /* Obsolete */
 186 #define NFSV2PROC_LOOKUP        4
 187 #define NFSV2PROC_READLINK      5
 188 #define NFSV2PROC_READ          6
 189 #define NFSV2PROC_WRITECACHE    NFSV2PROC_NOOP  /* Obsolete */
 190 #define NFSV2PROC_WRITE         8
 191 #define NFSV2PROC_CREATE        9
 192 #define NFSV2PROC_REMOVE        10
 193 #define NFSV2PROC_RENAME        11
 194 #define NFSV2PROC_LINK          12
 195 #define NFSV2PROC_SYMLINK       13
 196 #define NFSV2PROC_MKDIR         14
 197 #define NFSV2PROC_RMDIR         15
 198 #define NFSV2PROC_READDIR       16
 199 #define NFSV2PROC_STATFS        17
 200
 201 /*
 202  * Constants used by the Version 3 protocol for various RPCs
 203  */
 204 #define NFSV3SATTRTIME_DONTCHANGE       0
 205 #define NFSV3SATTRTIME_TOSERVER         1
 206 #define NFSV3SATTRTIME_TOCLIENT         2
 207
 208 #define NFSV3ATTRTIME_NMODES            3
 209
 210 #define NFSV3ACCESS_READ                0x01
 211 #define NFSV3ACCESS_LOOKUP              0x02
 212 #define NFSV3ACCESS_MODIFY              0x04
 213 #define NFSV3ACCESS_EXTEND              0x08
 214 #define NFSV3ACCESS_DELETE              0x10
 215 #define NFSV3ACCESS_EXECUTE             0x20
 216
 217 #define NFSV3WRITE_UNSTABLE             0
 218 #define NFSV3WRITE_DATASYNC             1
 219 #define NFSV3WRITE_FILESYNC             2
 220
 221 #define NFSV3WRITE_NMODES               3
 222
 223 #define NFSV3CREATE_UNCHECKED           0
 224 #define NFSV3CREATE_GUARDED             1
 225 #define NFSV3CREATE_EXCLUSIVE           2
 226
 227 #define NFSV3CREATE_NMODES              3
 228
 229 #define NFSV3FSINFO_LINK                0x01
 230 #define NFSV3FSINFO_SYMLINK             0x02
 231 #define NFSV3FSINFO_HOMOGENEOUS         0x08
 232 #define NFSV3FSINFO_CANSETTIME          0x10
 233
 234 /* Conversion macros */
 235 #define vtonfsv2_mode(t,m) \
 236                 txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : \
 237                                 MAKEIMODE((t), (m)))
 238 #define vtonfsv3_mode(m)        txdr_unsigned((m) & 07777)
 239 #define nfstov_mode(a)          (fxdr_unsigned(u_int16_t, (a))&07777)
 240 #define vtonfsv2_type(a)        txdr_unsigned(nfsv2_type[((int32_t)(a))])
 241 #define vtonfsv3_type(a)        txdr_unsigned(nfsv3_type[((int32_t)(a))])
 242 #define nfsv2tov_type(a)        nv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
 243 #define nfsv3tov_type(a)        nv3tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
 244
 245 /* File types */
 246 typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
 247         NFSOCK=6, NFFIFO=7 } nfs_type;
 248
 249 /* Structs for common parts of the rpc's */
 250 /*
 251  * File Handle (32 bytes for version 2), variable up to 64 for version 3.
 252  * File Handles of up to NFS_SMALLFH in size are stored directly in the
 253  * nfs node, whereas larger ones are malloc'd. (This never happens when
 254  * NFS_SMALLFH is set to 64.)
 255  * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4.
 256  */
 257 #ifndef NFS_SMALLFH
 258 #define NFS_SMALLFH     64
 259 #endif
 260 union nfsfh {
 261 /*      fhandle_t fh_generic; */
 262         u_char    fh_bytes[NFS_SMALLFH];
 263 };
 264 typedef union nfsfh nfsfh_t;
 265
 266 struct nfsv2_time {
 267         u_int32_t nfsv2_sec;
 268         u_int32_t nfsv2_usec;
 269 };
 270 typedef struct nfsv2_time       nfstime2;
 271
 272 struct nfsv3_time {
 273         u_int32_t nfsv3_sec;
 274         u_int32_t nfsv3_nsec;
 275 };
 276 typedef struct nfsv3_time       nfstime3;
 277
 278 /*
 279  * Quads are defined as arrays of 2 longs to ensure dense packing for the
 280  * protocol and to facilitate xdr conversion.
 281  */
 282 struct nfs_uquad {
 283         u_int32_t nfsuquad[2];
 284 };
 285 typedef struct nfs_uquad        nfsuint64;
 286
 287 #if 0 /* XXX - this doesn't seemed to be used and it doesn't work
 288        * with non-gcc, so comment it out for now.
 289        */
 290
 291 /*
 292  * Used to convert between two u_longs and a u_quad_t.
 293  */
 294 union nfs_quadconvert {
 295         u_int32_t lval[2];
 296         u_int64_t qval;
 297 };
 298 typedef union nfs_quadconvert   nfsquad_t;
 299
 300 #endif
 301
 302 /*
 303  * NFS Version 3 special file number.
 304  */
 305 struct nfsv3_spec {
 306         u_int32_t specdata1;
 307         u_int32_t specdata2;
 308 };
 309 typedef struct nfsv3_spec       nfsv3spec;
 310
 311 /*
 312  * File attributes and setable attributes. These structures cover both
 313  * NFS version 2 and the version 3 protocol. Note that the union is only
 314  * used so that one pointer can refer to both variants. These structures
 315  * go out on the wire and must be densely packed, so no quad data types
 316  * are used. (all fields are longs or u_longs or structures of same)
 317  * NB: You can't do sizeof(struct nfs_fattr), you must use the
 318  *     NFSX_FATTR(v3) macro.
 319  */
 320 struct nfs_fattr {
 321         u_int32_t fa_type;
 322         u_int32_t fa_mode;
 323         u_int32_t fa_nlink;
 324         u_int32_t fa_uid;
 325         u_int32_t fa_gid;
 326         union {
 327                 struct {
 328                         u_int32_t nfsv2fa_size;
 329                         u_int32_t nfsv2fa_blocksize;
 330                         u_int32_t nfsv2fa_rdev;
 331                         u_int32_t nfsv2fa_blocks;
 332                         u_int32_t nfsv2fa_fsid;
 333                         u_int32_t nfsv2fa_fileid;
 334                         nfstime2  nfsv2fa_atime;
 335                         nfstime2  nfsv2fa_mtime;
 336                         nfstime2  nfsv2fa_ctime;
 337                 } fa_nfsv2;
 338                 struct {
 339                         nfsuint64 nfsv3fa_size;
 340                         nfsuint64 nfsv3fa_used;
 341                         nfsv3spec nfsv3fa_rdev;
 342                         nfsuint64 nfsv3fa_fsid;
 343                         nfsuint64 nfsv3fa_fileid;
 344                         nfstime3  nfsv3fa_atime;
 345                         nfstime3  nfsv3fa_mtime;
 346                         nfstime3  nfsv3fa_ctime;
 347                 } fa_nfsv3;
 348         } fa_un;
 349 };
 350
 351 /* and some ugly defines for accessing union components */
 352 #define fa2_size                fa_un.fa_nfsv2.nfsv2fa_size
 353 #define fa2_blocksize           fa_un.fa_nfsv2.nfsv2fa_blocksize
 354 #define fa2_rdev                fa_un.fa_nfsv2.nfsv2fa_rdev
 355 #define fa2_blocks              fa_un.fa_nfsv2.nfsv2fa_blocks
 356 #define fa2_fsid                fa_un.fa_nfsv2.nfsv2fa_fsid
 357 #define fa2_fileid              fa_un.fa_nfsv2.nfsv2fa_fileid
 358 #define fa2_atime               fa_un.fa_nfsv2.nfsv2fa_atime
 359 #define fa2_mtime               fa_un.fa_nfsv2.nfsv2fa_mtime
 360 #define fa2_ctime               fa_un.fa_nfsv2.nfsv2fa_ctime
 361 #define fa3_size                fa_un.fa_nfsv3.nfsv3fa_size
 362 #define fa3_used                fa_un.fa_nfsv3.nfsv3fa_used
 363 #define fa3_rdev                fa_un.fa_nfsv3.nfsv3fa_rdev
 364 #define fa3_fsid                fa_un.fa_nfsv3.nfsv3fa_fsid
 365 #define fa3_fileid              fa_un.fa_nfsv3.nfsv3fa_fileid
 366 #define fa3_atime               fa_un.fa_nfsv3.nfsv3fa_atime
 367 #define fa3_mtime               fa_un.fa_nfsv3.nfsv3fa_mtime
 368 #define fa3_ctime               fa_un.fa_nfsv3.nfsv3fa_ctime
 369
 370 struct nfsv2_sattr {
 371         u_int32_t sa_mode;
 372         u_int32_t sa_uid;
 373         u_int32_t sa_gid;
 374         u_int32_t sa_size;
 375         nfstime2  sa_atime;
 376         nfstime2  sa_mtime;
 377 };
 378
 379 /*
 380  * NFS Version 3 sattr structure for the new node creation case.
 381  */
 382 struct nfsv3_sattr {
 383         u_int32_t   sa_modeset;
 384         u_int32_t   sa_mode;
 385         u_int32_t   sa_uidset;
 386         u_int32_t   sa_uid;
 387         u_int32_t   sa_gidset;
 388         u_int32_t   sa_gid;
 389         u_int32_t   sa_sizeset;
 390         u_int32_t   sa_size;
 391         u_int32_t   sa_atimetype;
 392         nfstime3  sa_atime;
 393         u_int32_t   sa_mtimetype;
 394         nfstime3  sa_mtime;
 395 };
 396
 397 struct nfs_statfs {
 398         union {
 399                 struct {
 400                         u_int32_t nfsv2sf_tsize;
 401                         u_int32_t nfsv2sf_bsize;
 402                         u_int32_t nfsv2sf_blocks;
 403                         u_int32_t nfsv2sf_bfree;
 404                         u_int32_t nfsv2sf_bavail;
 405                 } sf_nfsv2;
 406                 struct {
 407                         nfsuint64 nfsv3sf_tbytes;
 408                         nfsuint64 nfsv3sf_fbytes;
 409                         nfsuint64 nfsv3sf_abytes;
 410                         nfsuint64 nfsv3sf_tfiles;
 411                         nfsuint64 nfsv3sf_ffiles;
 412                         nfsuint64 nfsv3sf_afiles;
 413                         u_int32_t nfsv3sf_invarsec;
 414                 } sf_nfsv3;
 415         } sf_un;
 416 };
 417
 418 #define sf_tsize        sf_un.sf_nfsv2.nfsv2sf_tsize
 419 #define sf_bsize        sf_un.sf_nfsv2.nfsv2sf_bsize
 420 #define sf_blocks       sf_un.sf_nfsv2.nfsv2sf_blocks
 421 #define sf_bfree        sf_un.sf_nfsv2.nfsv2sf_bfree
 422 #define sf_bavail       sf_un.sf_nfsv2.nfsv2sf_bavail
 423 #define sf_tbytes       sf_un.sf_nfsv3.nfsv3sf_tbytes
 424 #define sf_fbytes       sf_un.sf_nfsv3.nfsv3sf_fbytes
 425 #define sf_abytes       sf_un.sf_nfsv3.nfsv3sf_abytes
 426 #define sf_tfiles       sf_un.sf_nfsv3.nfsv3sf_tfiles
 427 #define sf_ffiles       sf_un.sf_nfsv3.nfsv3sf_ffiles
 428 #define sf_afiles       sf_un.sf_nfsv3.nfsv3sf_afiles
 429 #define sf_invarsec     sf_un.sf_nfsv3.nfsv3sf_invarsec
 430
 431 struct nfsv3_fsinfo {
 432         u_int32_t fs_rtmax;
 433         u_int32_t fs_rtpref;
 434         u_int32_t fs_rtmult;
 435         u_int32_t fs_wtmax;
 436         u_int32_t fs_wtpref;
 437         u_int32_t fs_wtmult;
 438         u_int32_t fs_dtpref;
 439         nfsuint64 fs_maxfilesize;
 440         nfstime3  fs_timedelta;
 441         u_int32_t fs_properties;
 442 };
 443
 444 struct nfsv3_pathconf {
 445         u_int32_t pc_linkmax;
 446         u_int32_t pc_namemax;
 447         u_int32_t pc_notrunc;
 448         u_int32_t pc_chownrestricted;
 449         u_int32_t pc_caseinsensitive;
 450         u_int32_t pc_casepreserving;
 451 };