bsd/nfs/nfsproto.h

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