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_V3POSTOPATTR (NFSX_V3FATTR + NFSX_UNSIGNED) 118#define NFSX_V3WCCDATA (NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED) 119#define NFSX_V3COOKIEVERF 8 120#define NFSX_V3WRITEVERF 8 121#define NFSX_V3CREATEVERF 8 122#define NFSX_V3STATFS 52 123#define NFSX_V3FSINFO 48 124#define NFSX_V3PATHCONF 24 125 126/* variants for both versions */ 127#define NFSX_FH(v3) ((v3) ? (NFSX_V3FHMAX + NFSX_UNSIGNED) : \ 128 NFSX_V2FH) 129#define NFSX_SRVFH(v3) ((v3) ? NFSX_V3FH : NFSX_V2FH) 130#define NFSX_FATTR(v3) ((v3) ? NFSX_V3FATTR : NFSX_V2FATTR) 131#define NFSX_PREOPATTR(v3) ((v3) ? (7 * NFSX_UNSIGNED) : 0) 132#define NFSX_POSTOPATTR(v3) ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : 0) 133#define NFSX_POSTOPORFATTR(v3) ((v3) ? (NFSX_V3FATTR + NFSX_UNSIGNED) : \ 134 NFSX_V2FATTR) 135#define NFSX_WCCDATA(v3) ((v3) ? NFSX_V3WCCDATA : 0) 136#define NFSX_WCCORFATTR(v3) ((v3) ? NFSX_V3WCCDATA : NFSX_V2FATTR) 137#define NFSX_COOKIEVERF(v3) ((v3) ? NFSX_V3COOKIEVERF : 0) 138#define NFSX_WRITEVERF(v3) ((v3) ? NFSX_V3WRITEVERF : 0) 139#define NFSX_READDIR(v3) ((v3) ? (5 * NFSX_UNSIGNED) : \ 140 (2 * NFSX_UNSIGNED)) 141#define NFSX_STATFS(v3) ((v3) ? NFSX_V3STATFS : NFSX_V2STATFS) 142 143/* nfs rpc procedure numbers (before version mapping) */ 144#define NFSPROC_NULL 0 145#define NFSPROC_GETATTR 1 146#define NFSPROC_SETATTR 2 147#define NFSPROC_LOOKUP 3 148#define NFSPROC_ACCESS 4 149#define NFSPROC_READLINK 5 150#define NFSPROC_READ 6 151#define NFSPROC_WRITE 7 152#define NFSPROC_CREATE 8 153#define NFSPROC_MKDIR 9 154#define NFSPROC_SYMLINK 10 155#define NFSPROC_MKNOD 11 156#define NFSPROC_REMOVE 12 157#define NFSPROC_RMDIR 13 158#define NFSPROC_RENAME 14 159#define NFSPROC_LINK 15 160#define NFSPROC_READDIR 16 161#define NFSPROC_READDIRPLUS 17 162#define NFSPROC_FSSTAT 18 163#define NFSPROC_FSINFO 19 164#define NFSPROC_PATHCONF 20 165#define NFSPROC_COMMIT 21 166 167/* And leasing (nqnfs) procedure numbers (must be last) */ 168#define NQNFSPROC_GETLEASE 22 169#define NQNFSPROC_VACATED 23 170#define NQNFSPROC_EVICTED 24 171 172#define NFSPROC_NOOP 25 173#define NFS_NPROCS 26 174 175/* Actual Version 2 procedure numbers */ 176#define NFSV2PROC_NULL 0 177#define NFSV2PROC_GETATTR 1 178#define NFSV2PROC_SETATTR 2 179#define NFSV2PROC_NOOP 3 180#define NFSV2PROC_ROOT NFSV2PROC_NOOP /* Obsolete */ 181#define NFSV2PROC_LOOKUP 4 182#define NFSV2PROC_READLINK 5 183#define NFSV2PROC_READ 6 184#define NFSV2PROC_WRITECACHE NFSV2PROC_NOOP /* Obsolete */ 185#define NFSV2PROC_WRITE 8 186#define NFSV2PROC_CREATE 9 187#define NFSV2PROC_REMOVE 10 188#define NFSV2PROC_RENAME 11 189#define NFSV2PROC_LINK 12 190#define NFSV2PROC_SYMLINK 13 191#define NFSV2PROC_MKDIR 14 192#define NFSV2PROC_RMDIR 15 193#define NFSV2PROC_READDIR 16 194#define NFSV2PROC_STATFS 17 195 196/* 197 * Constants used by the Version 3 protocol for various RPCs 198 */ 199#define NFSV3SATTRTIME_DONTCHANGE 0 200#define NFSV3SATTRTIME_TOSERVER 1 201#define NFSV3SATTRTIME_TOCLIENT 2 202 203#define NFSV3ATTRTIME_NMODES 3 204 205#define NFSV3ACCESS_READ 0x01 206#define NFSV3ACCESS_LOOKUP 0x02 207#define NFSV3ACCESS_MODIFY 0x04 208#define NFSV3ACCESS_EXTEND 0x08 209#define NFSV3ACCESS_DELETE 0x10 210#define NFSV3ACCESS_EXECUTE 0x20 211#define NFSV3ACCESS_FULL 0x3f 212 213#define NFSV3WRITE_UNSTABLE 0 214#define NFSV3WRITE_DATASYNC 1 215#define NFSV3WRITE_FILESYNC 2 216 217#define NFSV3WRITE_NMODES 3 218 219#define NFSV3CREATE_UNCHECKED 0 220#define NFSV3CREATE_GUARDED 1 221#define NFSV3CREATE_EXCLUSIVE 2 222 223#define NFSV3CREATE_NMODES 3 224 225#define NFSV3FSINFO_LINK 0x01 226#define NFSV3FSINFO_SYMLINK 0x02 227#define NFSV3FSINFO_HOMOGENEOUS 0x08 228#define NFSV3FSINFO_CANSETTIME 0x10 229 230/* Conversion macros */ 231#define vtonfsv2_mode(t,m) \ 232 txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) : \ 233 MAKEIMODE((t), (m))) 234#define vtonfsv3_mode(m) txdr_unsigned((m) & 07777) 235#define nfstov_mode(a) (fxdr_unsigned(uint16_t, (a))&07777) 236#define vtonfsv2_type(a) txdr_unsigned(nfsv2_type[((int32_t)(a))]) 237#define vtonfsv3_type(a) txdr_unsigned(nfsv3_type[((int32_t)(a))]) 238#define nfsv2tov_type(a) nv2tov_type[fxdr_unsigned(uint32_t,(a))&0x7] 239#define nfsv3tov_type(a) nv3tov_type[fxdr_unsigned(uint32_t,(a))&0x7] 240 241/* File types */ 242typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5, 243 NFSOCK=6, NFFIFO=7 } nfs_type; 244 245/* 246 * Structs for common parts of the rpc's 247 * 248 * NOTE: these structures are not always overlaid directly on the 249 * packet data - sometimes we declare a local variable of that type, 250 * and fill it up with fields extracted using byte pointers - so we 251 * don't use nd_ types for their members. 252 */ 253 254/* 255 * File Handle (32 bytes for version 2), variable up to 64 for version 3. 256 * File Handles of up to NFS_SMALLFH in size are stored directly in the 257 * nfs node, whereas larger ones are malloc'd. (This never happens when 258 * NFS_SMALLFH is set to 64.) 259 * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4. 260 */ 261#ifndef NFS_SMALLFH 262#define NFS_SMALLFH 64 263#endif 264union nfsfh { 265/* fhandle_t fh_generic; */ 266 u_char fh_bytes[NFS_SMALLFH]; 267}; 268typedef union nfsfh nfsfh_t; 269 270struct nfsv2_time { 271 nd_uint32_t nfsv2_sec; 272 nd_uint32_t nfsv2_usec; 273}; 274typedef struct nfsv2_time nfstime2; 275 276struct nfsv3_time { 277 nd_uint32_t nfsv3_sec; 278 nd_uint32_t nfsv3_nsec; 279}; 280typedef struct nfsv3_time nfstime3; 281 282/* 283 * NFS Version 3 special file number. 284 */ 285struct nfsv3_spec { 286 nd_uint32_t specdata1; 287 nd_uint32_t specdata2; 288}; 289typedef struct nfsv3_spec nfsv3spec; 290 291/* 292 * File attributes and setable attributes. These structures cover both 293 * NFS version 2 and the version 3 protocol. Note that the union is only 294 * used so that one pointer can refer to both variants. These structures 295 * go out on the wire and must be densely packed, so no quad data types 296 * are used. (all fields are longs or u_longs or structures of same) 297 * NB: You can't do sizeof(struct nfs_fattr), you must use the 298 * NFSX_FATTR(v3) macro. 299 */ 300struct nfs_fattr { 301 nd_uint32_t fa_type; 302 nd_uint32_t fa_mode; 303 nd_uint32_t fa_nlink; 304 nd_uint32_t fa_uid; 305 nd_uint32_t fa_gid; 306 union { 307 struct { 308 nd_uint32_t nfsv2fa_size; 309 nd_uint32_t nfsv2fa_blocksize; 310 nd_uint32_t nfsv2fa_rdev; 311 nd_uint32_t nfsv2fa_blocks; 312 nd_uint32_t nfsv2fa_fsid; 313 nd_uint32_t nfsv2fa_fileid; 314 nfstime2 nfsv2fa_atime; 315 nfstime2 nfsv2fa_mtime; 316 nfstime2 nfsv2fa_ctime; 317 } fa_nfsv2; 318 struct { 319 nd_uint64_t nfsv3fa_size; 320 nd_uint64_t nfsv3fa_used; 321 nfsv3spec nfsv3fa_rdev; 322 nd_uint64_t nfsv3fa_fsid; 323 nd_uint64_t nfsv3fa_fileid; 324 nfstime3 nfsv3fa_atime; 325 nfstime3 nfsv3fa_mtime; 326 nfstime3 nfsv3fa_ctime; 327 } fa_nfsv3; 328 } fa_un; 329}; 330 331/* and some ugly defines for accessing union components */ 332#define fa2_size fa_un.fa_nfsv2.nfsv2fa_size 333#define fa2_blocksize fa_un.fa_nfsv2.nfsv2fa_blocksize 334#define fa2_rdev fa_un.fa_nfsv2.nfsv2fa_rdev 335#define fa2_blocks fa_un.fa_nfsv2.nfsv2fa_blocks 336#define fa2_fsid fa_un.fa_nfsv2.nfsv2fa_fsid 337#define fa2_fileid fa_un.fa_nfsv2.nfsv2fa_fileid 338#define fa2_atime fa_un.fa_nfsv2.nfsv2fa_atime 339#define fa2_mtime fa_un.fa_nfsv2.nfsv2fa_mtime 340#define fa2_ctime fa_un.fa_nfsv2.nfsv2fa_ctime 341#define fa3_size fa_un.fa_nfsv3.nfsv3fa_size 342#define fa3_used fa_un.fa_nfsv3.nfsv3fa_used 343#define fa3_rdev fa_un.fa_nfsv3.nfsv3fa_rdev 344#define fa3_fsid fa_un.fa_nfsv3.nfsv3fa_fsid 345#define fa3_fileid fa_un.fa_nfsv3.nfsv3fa_fileid 346#define fa3_atime fa_un.fa_nfsv3.nfsv3fa_atime 347#define fa3_mtime fa_un.fa_nfsv3.nfsv3fa_mtime 348#define fa3_ctime fa_un.fa_nfsv3.nfsv3fa_ctime 349 350struct nfsv2_sattr { 351 nd_uint32_t sa_mode; 352 nd_uint32_t sa_uid; 353 nd_uint32_t sa_gid; 354 nd_uint32_t sa_size; 355 nfstime2 sa_atime; 356 nfstime2 sa_mtime; 357}; 358 359struct nfs_statfs { 360 union { 361 struct { 362 nd_uint32_t nfsv2sf_tsize; 363 nd_uint32_t nfsv2sf_bsize; 364 nd_uint32_t nfsv2sf_blocks; 365 nd_uint32_t nfsv2sf_bfree; 366 nd_uint32_t nfsv2sf_bavail; 367 } sf_nfsv2; 368 struct { 369 nd_uint64_t nfsv3sf_tbytes; 370 nd_uint64_t nfsv3sf_fbytes; 371 nd_uint64_t nfsv3sf_abytes; 372 nd_uint64_t nfsv3sf_tfiles; 373 nd_uint64_t nfsv3sf_ffiles; 374 nd_uint64_t nfsv3sf_afiles; 375 nd_uint32_t nfsv3sf_invarsec; 376 } sf_nfsv3; 377 } sf_un; 378}; 379 380#define sf_tsize sf_un.sf_nfsv2.nfsv2sf_tsize 381#define sf_bsize sf_un.sf_nfsv2.nfsv2sf_bsize 382#define sf_blocks sf_un.sf_nfsv2.nfsv2sf_blocks 383#define sf_bfree sf_un.sf_nfsv2.nfsv2sf_bfree 384#define sf_bavail sf_un.sf_nfsv2.nfsv2sf_bavail 385#define sf_tbytes sf_un.sf_nfsv3.nfsv3sf_tbytes 386#define sf_fbytes sf_un.sf_nfsv3.nfsv3sf_fbytes 387#define sf_abytes sf_un.sf_nfsv3.nfsv3sf_abytes 388#define sf_tfiles sf_un.sf_nfsv3.nfsv3sf_tfiles 389#define sf_ffiles sf_un.sf_nfsv3.nfsv3sf_ffiles 390#define sf_afiles sf_un.sf_nfsv3.nfsv3sf_afiles 391#define sf_invarsec sf_un.sf_nfsv3.nfsv3sf_invarsec 392 393struct nfsv3_fsinfo { 394 nd_uint32_t fs_rtmax; 395 nd_uint32_t fs_rtpref; 396 nd_uint32_t fs_rtmult; 397 nd_uint32_t fs_wtmax; 398 nd_uint32_t fs_wtpref; 399 nd_uint32_t fs_wtmult; 400 nd_uint32_t fs_dtpref; 401 nd_uint64_t fs_maxfilesize; 402 nfstime3 fs_timedelta; 403 nd_uint32_t fs_properties; 404}; 405 406struct nfsv3_pathconf { 407 nd_uint32_t pc_linkmax; 408 nd_uint32_t pc_namemax; 409 nd_uint32_t pc_notrunc; 410 nd_uint32_t pc_chownrestricted; 411 nd_uint32_t pc_caseinsensitive; 412 nd_uint32_t pc_casepreserving; 413}; 414