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