bsd/nfs/nfsproto.h

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