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