external/bsd/tcpdump/dist/nfs.h

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