1 /* 2 * Copyright (c) 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Rick Macklem at The University of Guelph. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by the University of 19 * California, Berkeley and its contributors. 20 * 4. Neither the name of the University nor the names of its contributors 21 * may be used to endorse or promote products derived from this software 22 * without specific prior written permission. 23 * 24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 34 * SUCH DAMAGE. 35 * 36 * @(#)nfsproto.h 8.2 (Berkeley) 3/30/95 37 * $FreeBSD: src/sys/nfs/nfsproto.h,v 1.7 1999/08/28 00:50:03 peter Exp $ 38 * $DragonFly: src/sys/vfs/nfs/nfsproto.h,v 1.3 2004/03/08 23:52:53 dillon Exp $ 39 */ 40 41 #ifndef _NFS_NFSPROTO_H_ 42 #define _NFS_NFSPROTO_H_ 43 44 /* 45 * nfs definitions as per the Version 2 and 3 specs 46 */ 47 48 /* 49 * Constants as defined in the Sun NFS Version 2 and 3 specs. 50 * "NFS: Network File System Protocol Specification" RFC1094 51 * and in the "NFS: Network File System Version 3 Protocol 52 * Specification" 53 */ 54 55 #define NFS_PORT 2049 56 #define NFS_PROG 100003 57 #define NFS_VER2 2 58 #define NFS_VER3 3 59 #define NFS_V2MAXDATA 8192 60 #define NFS_MAXDGRAMDATA 16384 61 #define NFS_MAXDATA 32768 62 #define NFS_MAXPATHLEN 1024 63 #define NFS_MAXNAMLEN 255 64 #define NFS_MAXPKTHDR 404 65 #define NFS_MAXPACKET (NFS_MAXPKTHDR + NFS_MAXDATA) 66 #define NFS_MINPACKET 20 67 #define NFS_FABLKSIZE 512 /* Size in bytes of a block wrt fa_blocks */ 68 69 /* Stat numbers for rpc returns (version 2 and 3) */ 70 #define NFS_OK 0 71 #define NFSERR_PERM 1 72 #define NFSERR_NOENT 2 73 #define NFSERR_IO 5 74 #define NFSERR_NXIO 6 75 #define NFSERR_ACCES 13 76 #define NFSERR_EXIST 17 77 #define NFSERR_XDEV 18 /* Version 3 only */ 78 #define NFSERR_NODEV 19 79 #define NFSERR_NOTDIR 20 80 #define NFSERR_ISDIR 21 81 #define NFSERR_INVAL 22 /* Version 3 only */ 82 #define NFSERR_FBIG 27 83 #define NFSERR_NOSPC 28 84 #define NFSERR_ROFS 30 85 #define NFSERR_MLINK 31 /* Version 3 only */ 86 #define NFSERR_NAMETOL 63 87 #define NFSERR_NOTEMPTY 66 88 #define NFSERR_DQUOT 69 89 #define NFSERR_STALE 70 90 #define NFSERR_REMOTE 71 /* Version 3 only */ 91 #define NFSERR_WFLUSH 99 /* Version 2 only */ 92 #define NFSERR_BADHANDLE 10001 /* The rest Version 3 only */ 93 #define NFSERR_NOT_SYNC 10002 94 #define NFSERR_BAD_COOKIE 10003 95 #define NFSERR_NOTSUPP 10004 96 #define NFSERR_TOOSMALL 10005 97 #define NFSERR_SERVERFAULT 10006 98 #define NFSERR_BADTYPE 10007 99 #define NFSERR_JUKEBOX 10008 100 #define NFSERR_TRYLATER NFSERR_JUKEBOX 101 #define NFSERR_STALEWRITEVERF 30001 /* Fake return for nfs_commit() */ 102 103 #define NFSERR_RETVOID 0x20000000 /* Return void, not error */ 104 #define NFSERR_AUTHERR 0x40000000 /* Mark an authentication error */ 105 #define NFSERR_RETERR 0x80000000 /* Mark an error return for V3 */ 106 107 /* Sizes in bytes of various nfs rpc components */ 108 #define NFSX_UNSIGNED 4 109 110 /* specific to NFS Version 2 */ 111 #define NFSX_V2FH 32 112 #define NFSX_V2FATTR 68 113 #define NFSX_V2SATTR 32 114 #define NFSX_V2COOKIE 4 115 #define NFSX_V2STATFS 20 116 117 /* specific to NFS Version 3 */ 118 #define NFSX_V3FH (sizeof (fhandle_t)) /* size this server uses */ 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 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 NFSV3CREATE_UNCHECKED 0 222 #define NFSV3CREATE_GUARDED 1 223 #define NFSV3CREATE_EXCLUSIVE 2 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) & ALLPERMS) 235 #define nfstov_mode(a) (fxdr_unsigned(u_int32_t, (a)) & ALLPERMS) 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(u_int32_t,(a))&0x7] 239 #define nfsv3tov_type(a) nv3tov_type[fxdr_unsigned(u_int32_t,(a))&0x7] 240 241 /* File types */ 242 typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5, 243 NFSOCK=6, NFFIFO=7 } nfstype; 244 245 /* Structs for common parts of the rpc's */ 246 /* 247 * File Handle (32 bytes for version 2), variable up to 64 for version 3. 248 * File Handles of up to NFS_SMALLFH in size are stored directly in the 249 * nfs node, whereas larger ones are malloc'd. (This never happens when 250 * NFS_SMALLFH is set to 64.) 251 * NFS_SMALLFH should be in the range of 32 to 64 and be divisible by 4. 252 */ 253 #ifndef NFS_SMALLFH 254 #define NFS_SMALLFH 64 255 #endif 256 union nfsfh { 257 fhandle_t fh_generic; 258 u_char fh_bytes[NFS_SMALLFH]; 259 }; 260 typedef union nfsfh nfsfh_t; 261 262 struct nfsv2_time { 263 u_int32_t nfsv2_sec; 264 u_int32_t nfsv2_usec; 265 }; 266 typedef struct nfsv2_time nfstime2; 267 268 struct nfsv3_time { 269 u_int32_t nfsv3_sec; 270 u_int32_t nfsv3_nsec; 271 }; 272 typedef struct nfsv3_time nfstime3; 273 274 /* 275 * Quads are defined as arrays of 2 longs to ensure dense packing for the 276 * protocol and to facilitate xdr conversion. 277 */ 278 struct nfs_uquad { 279 u_int32_t nfsuquad[2]; 280 }; 281 typedef struct nfs_uquad nfsuint64; 282 283 /* 284 * Used to convert between two u_longs and a u_quad_t. 285 */ 286 union nfs_quadconvert { 287 u_int32_t lval[2]; 288 u_quad_t qval; 289 }; 290 typedef union nfs_quadconvert nfsquad_t; 291 292 /* 293 * NFS Version 3 special file number. 294 */ 295 struct nfsv3_spec { 296 u_int32_t specdata1; 297 u_int32_t specdata2; 298 }; 299 typedef struct nfsv3_spec nfsv3spec; 300 301 /* 302 * File attributes and setable attributes. These structures cover both 303 * NFS version 2 and the version 3 protocol. Note that the union is only 304 * used so that one pointer can refer to both variants. These structures 305 * go out on the wire and must be densely packed, so no quad data types 306 * are used. (all fields are longs or u_longs or structures of same) 307 * NB: You can't do sizeof(struct nfs_fattr), you must use the 308 * NFSX_FATTR(v3) macro. 309 */ 310 struct nfs_fattr { 311 u_int32_t fa_type; 312 u_int32_t fa_mode; 313 u_int32_t fa_nlink; 314 u_int32_t fa_uid; 315 u_int32_t fa_gid; 316 union { 317 struct { 318 u_int32_t nfsv2fa_size; 319 u_int32_t nfsv2fa_blocksize; 320 u_int32_t nfsv2fa_rdev; 321 u_int32_t nfsv2fa_blocks; 322 u_int32_t nfsv2fa_fsid; 323 u_int32_t nfsv2fa_fileid; 324 nfstime2 nfsv2fa_atime; 325 nfstime2 nfsv2fa_mtime; 326 nfstime2 nfsv2fa_ctime; 327 } fa_nfsv2; 328 struct { 329 nfsuint64 nfsv3fa_size; 330 nfsuint64 nfsv3fa_used; 331 nfsv3spec nfsv3fa_rdev; 332 nfsuint64 nfsv3fa_fsid; 333 nfsuint64 nfsv3fa_fileid; 334 nfstime3 nfsv3fa_atime; 335 nfstime3 nfsv3fa_mtime; 336 nfstime3 nfsv3fa_ctime; 337 } fa_nfsv3; 338 } fa_un; 339 }; 340 341 /* and some ugly defines for accessing union components */ 342 #define fa2_size fa_un.fa_nfsv2.nfsv2fa_size 343 #define fa2_blocksize fa_un.fa_nfsv2.nfsv2fa_blocksize 344 #define fa2_rdev fa_un.fa_nfsv2.nfsv2fa_rdev 345 #define fa2_blocks fa_un.fa_nfsv2.nfsv2fa_blocks 346 #define fa2_fsid fa_un.fa_nfsv2.nfsv2fa_fsid 347 #define fa2_fileid fa_un.fa_nfsv2.nfsv2fa_fileid 348 #define fa2_atime fa_un.fa_nfsv2.nfsv2fa_atime 349 #define fa2_mtime fa_un.fa_nfsv2.nfsv2fa_mtime 350 #define fa2_ctime fa_un.fa_nfsv2.nfsv2fa_ctime 351 #define fa3_size fa_un.fa_nfsv3.nfsv3fa_size 352 #define fa3_used fa_un.fa_nfsv3.nfsv3fa_used 353 #define fa3_rdev fa_un.fa_nfsv3.nfsv3fa_rdev 354 #define fa3_fsid fa_un.fa_nfsv3.nfsv3fa_fsid 355 #define fa3_fileid fa_un.fa_nfsv3.nfsv3fa_fileid 356 #define fa3_atime fa_un.fa_nfsv3.nfsv3fa_atime 357 #define fa3_mtime fa_un.fa_nfsv3.nfsv3fa_mtime 358 #define fa3_ctime fa_un.fa_nfsv3.nfsv3fa_ctime 359 360 struct nfsv2_sattr { 361 u_int32_t sa_mode; 362 u_int32_t sa_uid; 363 u_int32_t sa_gid; 364 u_int32_t sa_size; 365 nfstime2 sa_atime; 366 nfstime2 sa_mtime; 367 }; 368 369 /* 370 * NFS Version 3 sattr structure for the new node creation case. 371 */ 372 struct nfsv3_sattr { 373 u_int32_t sa_modetrue; 374 u_int32_t sa_mode; 375 u_int32_t sa_uidfalse; 376 u_int32_t sa_gidfalse; 377 u_int32_t sa_sizefalse; 378 u_int32_t sa_atimetype; 379 nfstime3 sa_atime; 380 u_int32_t sa_mtimetype; 381 nfstime3 sa_mtime; 382 }; 383 384 struct nfs_statfs { 385 union { 386 struct { 387 u_int32_t nfsv2sf_tsize; 388 u_int32_t nfsv2sf_bsize; 389 u_int32_t nfsv2sf_blocks; 390 u_int32_t nfsv2sf_bfree; 391 u_int32_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 u_int32_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 u_int32_t fs_rtmax; 420 u_int32_t fs_rtpref; 421 u_int32_t fs_rtmult; 422 u_int32_t fs_wtmax; 423 u_int32_t fs_wtpref; 424 u_int32_t fs_wtmult; 425 u_int32_t fs_dtpref; 426 nfsuint64 fs_maxfilesize; 427 nfstime3 fs_timedelta; 428 u_int32_t fs_properties; 429 }; 430 431 struct nfsv3_pathconf { 432 u_int32_t pc_linkmax; 433 u_int32_t pc_namemax; 434 u_int32_t pc_notrunc; 435 u_int32_t pc_chownrestricted; 436 u_int32_t pc_caseinsensitive; 437 u_int32_t pc_casepreserving; 438 }; 439 440 #endif 441