sys/fs/nfs/nfsproto.h

   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  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _NFS_NFSPROTO_H_
  36 #define _NFS_NFSPROTO_H_
  37
  38 /*
  39  * nfs definitions as per the Version 2, 3 and 4 specs
  40  */
  41
  42 /*
  43  * Constants as defined in the NFS Version 2, 3 and 4 specs.
  44  * "NFS: Network File System Protocol Specification" RFC1094
  45  * and in the "NFS: Network File System Version 3 Protocol
  46  * Specification"
  47  */
  48
  49 #define NFS_PORT        2049
  50 #define NFS_PROG        100003
  51 #define NFS_CALLBCKPROG 0x40000000      /* V4 only */
  52 #define NFS_VER2        2
  53 #define NFS_VER3        3
  54 #define NFS_VER4        4
  55 #define NFS_V2MAXDATA   8192
  56 #define NFS_MAXDGRAMDATA 16384
  57 #define NFS_MAXDATA     NFS_MAXBSIZE
  58 #define NFS_MAXPATHLEN  1024
  59 #define NFS_MAXNAMLEN   255
  60 #define NFS_MAXPKTHDR   404
  61 #define NFS_MAXPACKET   (NFS_MAXDATA + 2048)
  62 #define NFS_MINPACKET   20
  63 #define NFS_FABLKSIZE   512     /* Size in bytes of a block wrt fa_blocks */
  64 #define NFSV4_MINORVERSION      0       /* V4 Minor version */
  65 #define NFSV41_MINORVERSION     1       /* V4 Minor version */
  66 #define NFSV4_CBVERS            1       /* V4 CB Version */
  67 #define NFSV41_CBVERS           4       /* V4.1 CB Version */
  68 #define NFSV4_SMALLSTR  50              /* Strings small enough for stack */
  69
  70 /* Stat numbers for rpc returns (version 2, 3 and 4) */
  71 /*
  72  * These numbers are hard-wired in the RFCs, so they can't be changed.
  73  * The code currently assumes that the ones < 10000 are the same as
  74  * sys/errno.h and that sys/errno.h will never go as high as 10000.
  75  * If the value in sys/errno.h of any entry listed below is changed,
  76  * the NFS code must be modified to do the mapping between them.
  77  * (You can ignore NFSERR_WFLUSH, since it is never actually used.)
  78  */
  79 #define NFSERR_OK               0
  80 #define NFSERR_PERM             1
  81 #define NFSERR_NOENT            2
  82 #define NFSERR_IO               5
  83 #define NFSERR_NXIO             6
  84 #define NFSERR_ACCES            13
  85 #define NFSERR_EXIST            17
  86 #define NFSERR_XDEV             18      /* Version 3, 4 only */
  87 #define NFSERR_NODEV            19
  88 #define NFSERR_NOTDIR           20
  89 #define NFSERR_ISDIR            21
  90 #define NFSERR_INVAL            22      /* Version 3, 4 only */
  91 #define NFSERR_FBIG             27
  92 #define NFSERR_NOSPC            28
  93 #define NFSERR_ROFS             30
  94 #define NFSERR_MLINK            31      /* Version 3, 4 only */
  95 #define NFSERR_NAMETOL          63
  96 #define NFSERR_NOTEMPTY         66
  97 #define NFSERR_DQUOT            69
  98 #define NFSERR_STALE            70
  99 #define NFSERR_REMOTE           71      /* Version 3 only */
 100 #define NFSERR_WFLUSH           99      /* Version 2 only */
 101 #define NFSERR_BADHANDLE        10001   /* These are Version 3, 4 only */
 102 #define NFSERR_NOT_SYNC         10002   /* Version 3 Only */
 103 #define NFSERR_BAD_COOKIE       10003
 104 #define NFSERR_NOTSUPP          10004
 105 #define NFSERR_TOOSMALL         10005
 106 #define NFSERR_SERVERFAULT      10006
 107 #define NFSERR_BADTYPE          10007
 108 #define NFSERR_DELAY            10008   /* Called NFSERR_JUKEBOX for V3 */
 109 #define NFSERR_SAME             10009   /* These are Version 4 only */
 110 #define NFSERR_DENIED           10010
 111 #define NFSERR_EXPIRED          10011
 112 #define NFSERR_LOCKED           10012
 113 #define NFSERR_GRACE            10013
 114 #define NFSERR_FHEXPIRED        10014
 115 #define NFSERR_SHAREDENIED      10015
 116 #define NFSERR_WRONGSEC         10016
 117 #define NFSERR_CLIDINUSE        10017
 118 #define NFSERR_RESOURCE         10018
 119 #define NFSERR_MOVED            10019
 120 #define NFSERR_NOFILEHANDLE     10020
 121 #define NFSERR_MINORVERMISMATCH 10021
 122 #define NFSERR_STALECLIENTID    10022
 123 #define NFSERR_STALESTATEID     10023
 124 #define NFSERR_OLDSTATEID       10024
 125 #define NFSERR_BADSTATEID       10025
 126 #define NFSERR_BADSEQID         10026
 127 #define NFSERR_NOTSAME          10027
 128 #define NFSERR_LOCKRANGE        10028
 129 #define NFSERR_SYMLINK          10029
 130 #define NFSERR_RESTOREFH        10030
 131 #define NFSERR_LEASEMOVED       10031
 132 #define NFSERR_ATTRNOTSUPP      10032
 133 #define NFSERR_NOGRACE          10033
 134 #define NFSERR_RECLAIMBAD       10034
 135 #define NFSERR_RECLAIMCONFLICT  10035
 136 #define NFSERR_BADXDR           10036
 137 #define NFSERR_LOCKSHELD        10037
 138 #define NFSERR_OPENMODE         10038
 139 #define NFSERR_BADOWNER         10039
 140 #define NFSERR_BADCHAR          10040
 141 #define NFSERR_BADNAME          10041
 142 #define NFSERR_BADRANGE         10042
 143 #define NFSERR_LOCKNOTSUPP      10043
 144 #define NFSERR_OPILLEGAL        10044
 145 #define NFSERR_DEADLOCK         10045
 146 #define NFSERR_FILEOPEN         10046
 147 #define NFSERR_ADMINREVOKED     10047
 148 #define NFSERR_CBPATHDOWN       10048
 149
 150 /* NFSv4.1 specific errors. */
 151 #define NFSERR_BADIOMODE        10049
 152 #define NFSERR_BADLAYOUT        10050
 153 #define NFSERR_BADSESSIONDIGEST 10051
 154 #define NFSERR_BADSESSION       10052
 155 #define NFSERR_BADSLOT          10053
 156 #define NFSERR_COMPLETEALREADY  10054
 157 #define NFSERR_NOTBNDTOSESS     10055
 158 #define NFSERR_DELEGALREADYWANT 10056
 159 #define NFSERR_BACKCHANBUSY     10057
 160 #define NFSERR_LAYOUTTRYLATER   10058
 161 #define NFSERR_LAYOUTUNAVAIL    10059
 162 #define NFSERR_NOMATCHLAYOUT    10060
 163 #define NFSERR_RECALLCONFLICT   10061
 164 #define NFSERR_UNKNLAYOUTTYPE   10062
 165 #define NFSERR_SEQMISORDERED    10063
 166 #define NFSERR_SEQUENCEPOS      10064
 167 #define NFSERR_REQTOOBIG        10065
 168 #define NFSERR_REPTOOBIG        10066
 169 #define NFSERR_REPTOOBIGTOCACHE 10067
 170 #define NFSERR_RETRYUNCACHEDREP 10068
 171 #define NFSERR_UNSAFECOMPOUND   10069
 172 #define NFSERR_TOOMANYOPS       10070
 173 #define NFSERR_OPNOTINSESS      10071
 174 #define NFSERR_HASHALGUNSUPP    10072
 175 #define NFSERR_CLIENTIDBUSY     10074
 176 #define NFSERR_PNFSIOHOLE       10075
 177 #define NFSERR_SEQFALSERETRY    10076
 178 #define NFSERR_BADHIGHSLOT      10077
 179 #define NFSERR_DEADSESSION      10078
 180 #define NFSERR_ENCRALGUNSUPP    10079
 181 #define NFSERR_PNFSNOLAYOUT     10080
 182 #define NFSERR_NOTONLYOP        10081
 183 #define NFSERR_WRONGCRED        10082
 184 #define NFSERR_WRONGTYPE        10083
 185 #define NFSERR_DIRDELEGUNAVAIL  10084
 186 #define NFSERR_REJECTDELEG      10085
 187 #define NFSERR_RETURNCONFLICT   10086
 188 #define NFSERR_DELEGREVOKED     10087
 189
 190 #define NFSERR_STALEWRITEVERF   30001   /* Fake return for nfs_commit() */
 191 #define NFSERR_DONTREPLY        30003   /* Don't process request */
 192 #define NFSERR_RETVOID          30004   /* Return void, not error */
 193 #define NFSERR_REPLYFROMCACHE   30005   /* Reply from recent request cache */
 194 #define NFSERR_STALEDONTRECOVER 30006   /* Don't initiate recovery */
 195
 196 #define NFSERR_RPCERR           0x40000000 /* Mark an RPC layer error */
 197 #define NFSERR_AUTHERR          0x80000000 /* Mark an authentication error */
 198
 199 #define NFSERR_RPCMISMATCH      (NFSERR_RPCERR | RPC_MISMATCH)
 200 #define NFSERR_PROGUNAVAIL      (NFSERR_RPCERR | RPC_PROGUNAVAIL)
 201 #define NFSERR_PROGMISMATCH     (NFSERR_RPCERR | RPC_PROGMISMATCH)
 202 #define NFSERR_PROGNOTV4        (NFSERR_RPCERR | 0xffff)
 203 #define NFSERR_PROCUNAVAIL      (NFSERR_RPCERR | RPC_PROCUNAVAIL)
 204 #define NFSERR_GARBAGE          (NFSERR_RPCERR | RPC_GARBAGE)
 205
 206 /* Sizes in bytes of various nfs rpc components */
 207 #define NFSX_UNSIGNED   4
 208 #define NFSX_HYPER      (2 * NFSX_UNSIGNED)
 209
 210 /* specific to NFS Version 2 */
 211 #define NFSX_V2FH       32
 212 #define NFSX_V2FATTR    68
 213 #define NFSX_V2SATTR    32
 214 #define NFSX_V2COOKIE   4
 215 #define NFSX_V2STATFS   20
 216
 217 /* specific to NFS Version 3 */
 218 #define NFSX_V3FHMAX            64      /* max. allowed by protocol */
 219 #define NFSX_V3FATTR            84
 220 #define NFSX_V3SATTR            60      /* max. all fields filled in */
 221 #define NFSX_V3SRVSATTR         (sizeof (struct nfsv3_sattr))
 222 #define NFSX_V3POSTOPATTR       (NFSX_V3FATTR + NFSX_UNSIGNED)
 223 #define NFSX_V3WCCDATA          (NFSX_V3POSTOPATTR + 8 * NFSX_UNSIGNED)
 224 #define NFSX_V3STATFS           52
 225 #define NFSX_V3FSINFO           48
 226 #define NFSX_V3PATHCONF         24
 227
 228 /* specific to NFS Version 4 */
 229 #define NFSX_V4FHMAX            128
 230 #define NFSX_V4FSID             (2 * NFSX_HYPER)
 231 #define NFSX_V4SPECDATA         (2 * NFSX_UNSIGNED)
 232 #define NFSX_V4TIME             (NFSX_HYPER + NFSX_UNSIGNED)
 233 #define NFSX_V4SETTIME          (NFSX_UNSIGNED + NFSX_V4TIME)
 234 #define NFSX_V4SESSIONID        16
 235 #define NFSX_V4DEVICEID         16
 236
 237 /* sizes common to multiple NFS versions */
 238 #define NFSX_FHMAX              (NFSX_V4FHMAX)
 239 #define NFSX_MYFH               (sizeof (fhandle_t)) /* size this server uses */
 240 #define NFSX_VERF               8
 241 #define NFSX_STATEIDOTHER       12
 242 #define NFSX_STATEID            (NFSX_UNSIGNED + NFSX_STATEIDOTHER)
 243 #define NFSX_GSSH               12
 244
 245 /* variants for multiple versions */
 246 #define NFSX_STATFS(v3)         ((v3) ? NFSX_V3STATFS : NFSX_V2STATFS)
 247
 248 /* nfs rpc procedure numbers (before version mapping) */
 249 #define NFSPROC_NULL            0
 250 #define NFSPROC_GETATTR         1
 251 #define NFSPROC_SETATTR         2
 252 #define NFSPROC_LOOKUP          3
 253 #define NFSPROC_ACCESS          4
 254 #define NFSPROC_READLINK        5
 255 #define NFSPROC_READ            6
 256 #define NFSPROC_WRITE           7
 257 #define NFSPROC_CREATE          8
 258 #define NFSPROC_MKDIR           9
 259 #define NFSPROC_SYMLINK         10
 260 #define NFSPROC_MKNOD           11
 261 #define NFSPROC_REMOVE          12
 262 #define NFSPROC_RMDIR           13
 263 #define NFSPROC_RENAME          14
 264 #define NFSPROC_LINK            15
 265 #define NFSPROC_READDIR         16
 266 #define NFSPROC_READDIRPLUS     17
 267 #define NFSPROC_FSSTAT          18
 268 #define NFSPROC_FSINFO          19
 269 #define NFSPROC_PATHCONF        20
 270 #define NFSPROC_COMMIT          21
 271
 272 /*
 273  * The lower numbers -> 21 are used by NFSv2 and v3. These define higher
 274  * numbers used by NFSv4.
 275  * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is
 276  * one greater than the last number.
 277  */
 278 #ifndef NFS_V3NPROCS
 279 #define NFS_V3NPROCS            22
 280
 281 #define NFSPROC_LOOKUPP         22
 282 #define NFSPROC_SETCLIENTID     23
 283 #define NFSPROC_SETCLIENTIDCFRM 24
 284 #define NFSPROC_LOCK            25
 285 #define NFSPROC_LOCKU           26
 286 #define NFSPROC_OPEN            27
 287 #define NFSPROC_CLOSE           28
 288 #define NFSPROC_OPENCONFIRM     29
 289 #define NFSPROC_LOCKT           30
 290 #define NFSPROC_OPENDOWNGRADE   31
 291 #define NFSPROC_RENEW           32
 292 #define NFSPROC_PUTROOTFH       33
 293 #define NFSPROC_RELEASELCKOWN   34
 294 #define NFSPROC_DELEGRETURN     35
 295 #define NFSPROC_RETDELEGREMOVE  36
 296 #define NFSPROC_RETDELEGRENAME1 37
 297 #define NFSPROC_RETDELEGRENAME2 38
 298 #define NFSPROC_GETACL          39
 299 #define NFSPROC_SETACL          40
 300
 301 /*
 302  * Must be defined as one higher than the last Proc# above.
 303  */
 304 #define NFSV4_NPROCS            41
 305
 306 /* Additional procedures for NFSv4.1. */
 307 #define NFSPROC_EXCHANGEID      41
 308 #define NFSPROC_CREATESESSION   42
 309 #define NFSPROC_DESTROYSESSION  43
 310 #define NFSPROC_DESTROYCLIENT   44
 311 #define NFSPROC_FREESTATEID     45
 312 #define NFSPROC_LAYOUTGET       46
 313 #define NFSPROC_GETDEVICEINFO   47
 314 #define NFSPROC_LAYOUTCOMMIT    48
 315 #define NFSPROC_LAYOUTRETURN    49
 316 #define NFSPROC_RECLAIMCOMPL    50
 317 #define NFSPROC_WRITEDS         51
 318 #define NFSPROC_READDS          52
 319 #define NFSPROC_COMMITDS        53
 320
 321 /*
 322  * Must be defined as one higher than the last NFSv4.1 Proc# above.
 323  */
 324 #define NFSV41_NPROCS           54
 325
 326 #endif  /* NFS_V3NPROCS */
 327
 328 /*
 329  * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code.
 330  */
 331 #ifndef NFS_NPROCS
 332 #define NFS_NPROCS              NFSV4_NPROCS
 333 #endif
 334
 335 /*
 336  * NFSPROC_NOOP is a fake op# that can't be the same as any V2/3/4 Procedure
 337  * or Operation#. Since the NFS V4 Op #s go higher, use NFSV41_NOPS, which
 338  * is one greater than the highest Op#.
 339  */
 340 #define NFSPROC_NOOP            NFSV41_NOPS
 341
 342 /* Actual Version 2 procedure numbers */
 343 #define NFSV2PROC_NULL          0
 344 #define NFSV2PROC_GETATTR       1
 345 #define NFSV2PROC_SETATTR       2
 346 #define NFSV2PROC_NOOP          3
 347 #define NFSV2PROC_ROOT          NFSV2PROC_NOOP  /* Obsolete */
 348 #define NFSV2PROC_LOOKUP        4
 349 #define NFSV2PROC_READLINK      5
 350 #define NFSV2PROC_READ          6
 351 #define NFSV2PROC_WRITECACHE    NFSV2PROC_NOOP  /* Obsolete */
 352 #define NFSV2PROC_WRITE         8
 353 #define NFSV2PROC_CREATE        9
 354 #define NFSV2PROC_REMOVE        10
 355 #define NFSV2PROC_RENAME        11
 356 #define NFSV2PROC_LINK          12
 357 #define NFSV2PROC_SYMLINK       13
 358 #define NFSV2PROC_MKDIR         14
 359 #define NFSV2PROC_RMDIR         15
 360 #define NFSV2PROC_READDIR       16
 361 #define NFSV2PROC_STATFS        17
 362
 363 /*
 364  * V4 Procedure numbers
 365  */
 366 #define NFSV4PROC_COMPOUND      1
 367 #define NFSV4PROC_CBNULL        0
 368 #define NFSV4PROC_CBCOMPOUND    1
 369
 370 /*
 371  * Constants used by the Version 3 and 4 protocols for various RPCs
 372  */
 373 #define NFSV3SATTRTIME_DONTCHANGE       0
 374 #define NFSV3SATTRTIME_TOSERVER         1
 375 #define NFSV3SATTRTIME_TOCLIENT         2
 376
 377 #define NFSV4SATTRTIME_TOSERVER         0
 378 #define NFSV4SATTRTIME_TOCLIENT         1
 379
 380 #define NFSV4LOCKT_READ                 1
 381 #define NFSV4LOCKT_WRITE                2
 382 #define NFSV4LOCKT_READW                3
 383 #define NFSV4LOCKT_WRITEW               4
 384 #define NFSV4LOCKT_RELEASE              5
 385
 386 #define NFSV4OPEN_NOCREATE              0
 387 #define NFSV4OPEN_CREATE                1
 388 #define NFSV4OPEN_CLAIMNULL             0
 389 #define NFSV4OPEN_CLAIMPREVIOUS         1
 390 #define NFSV4OPEN_CLAIMDELEGATECUR      2
 391 #define NFSV4OPEN_CLAIMDELEGATEPREV     3
 392 #define NFSV4OPEN_DELEGATENONE          0
 393 #define NFSV4OPEN_DELEGATEREAD          1
 394 #define NFSV4OPEN_DELEGATEWRITE         2
 395 #define NFSV4OPEN_LIMITSIZE             1
 396 #define NFSV4OPEN_LIMITBLOCKS           2
 397
 398 /*
 399  * Nfs V4 ACE stuff
 400  */
 401 #define NFSV4ACE_ALLOWEDTYPE            0x00000000
 402 #define NFSV4ACE_DENIEDTYPE             0x00000001
 403 #define NFSV4ACE_AUDITTYPE              0x00000002
 404 #define NFSV4ACE_ALARMTYPE              0x00000003
 405
 406 #define NFSV4ACE_SUPALLOWED             0x00000001
 407 #define NFSV4ACE_SUPDENIED              0x00000002
 408 #define NFSV4ACE_SUPAUDIT               0x00000004
 409 #define NFSV4ACE_SUPALARM               0x00000008
 410
 411 #define NFSV4ACE_SUPTYPES       (NFSV4ACE_SUPALLOWED | NFSV4ACE_SUPDENIED)
 412
 413 #define NFSV4ACE_FILEINHERIT            0x00000001
 414 #define NFSV4ACE_DIRECTORYINHERIT       0x00000002
 415 #define NFSV4ACE_NOPROPAGATEINHERIT     0x00000004
 416 #define NFSV4ACE_INHERITONLY            0x00000008
 417 #define NFSV4ACE_SUCCESSFULACCESS       0x00000010
 418 #define NFSV4ACE_FAILEDACCESS           0x00000020
 419 #define NFSV4ACE_IDENTIFIERGROUP        0x00000040
 420
 421 #define NFSV4ACE_READDATA               0x00000001
 422 #define NFSV4ACE_LISTDIRECTORY          0x00000001
 423 #define NFSV4ACE_WRITEDATA              0x00000002
 424 #define NFSV4ACE_ADDFILE                0x00000002
 425 #define NFSV4ACE_APPENDDATA             0x00000004
 426 #define NFSV4ACE_ADDSUBDIRECTORY        0x00000004
 427 #define NFSV4ACE_READNAMEDATTR          0x00000008
 428 #define NFSV4ACE_WRITENAMEDATTR         0x00000010
 429 #define NFSV4ACE_EXECUTE                0x00000020
 430 #define NFSV4ACE_SEARCH                 0x00000020
 431 #define NFSV4ACE_DELETECHILD            0x00000040
 432 #define NFSV4ACE_READATTRIBUTES         0x00000080
 433 #define NFSV4ACE_WRITEATTRIBUTES        0x00000100
 434 #define NFSV4ACE_DELETE                 0x00010000
 435 #define NFSV4ACE_READACL                0x00020000
 436 #define NFSV4ACE_WRITEACL               0x00040000
 437 #define NFSV4ACE_WRITEOWNER             0x00080000
 438 #define NFSV4ACE_SYNCHRONIZE            0x00100000
 439
 440 /*
 441  * Here are the mappings between mode bits and acl mask bits for
 442  * directories and other files.
 443  * (Named attributes have not been included, since named attributes are
 444  *  not yet supported.)
 445  * The mailing list seems to indicate that NFSV4ACE_EXECUTE refers to
 446  * searching a directory, although I can't find a statement of that in
 447  * the RFC.
 448  */
 449 #define NFSV4ACE_ALLFILESMASK   (NFSV4ACE_READATTRIBUTES | NFSV4ACE_READACL)
 450 #define NFSV4ACE_OWNERMASK      (NFSV4ACE_WRITEATTRIBUTES | NFSV4ACE_WRITEACL)
 451 #define NFSV4ACE_DIRREADMASK    NFSV4ACE_LISTDIRECTORY
 452 #define NFSV4ACE_DIREXECUTEMASK NFSV4ACE_EXECUTE
 453 #define NFSV4ACE_DIRWRITEMASK   (NFSV4ACE_ADDFILE |                     \
 454                 NFSV4ACE_ADDSUBDIRECTORY | NFSV4ACE_DELETECHILD)
 455 #define NFSV4ACE_READMASK       NFSV4ACE_READDATA
 456 #define NFSV4ACE_WRITEMASK      (NFSV4ACE_WRITEDATA | NFSV4ACE_APPENDDATA)
 457 #define NFSV4ACE_EXECUTEMASK    NFSV4ACE_EXECUTE
 458 #define NFSV4ACE_ALLFILEBITS    (NFSV4ACE_READMASK | NFSV4ACE_WRITEMASK | \
 459         NFSV4ACE_EXECUTEMASK | NFSV4ACE_SYNCHRONIZE)
 460 #define NFSV4ACE_ALLDIRBITS     (NFSV4ACE_DIRREADMASK |                 \
 461         NFSV4ACE_DIRWRITEMASK | NFSV4ACE_DIREXECUTEMASK)
 462 #define NFSV4ACE_AUDITMASK      0x0
 463
 464 /*
 465  * These GENERIC masks are not used and are no longer believed to be useful.
 466  */
 467 #define NFSV4ACE_GENERICREAD            0x00120081
 468 #define NFSV4ACE_GENERICWRITE           0x00160106
 469 #define NFSV4ACE_GENERICEXECUTE         0x001200a0
 470
 471 #define NFSSTATEID_PUTALLZERO           0
 472 #define NFSSTATEID_PUTALLONE            1
 473 #define NFSSTATEID_PUTSTATEID           2
 474 #define NFSSTATEID_PUTSEQIDZERO         3
 475
 476 /*
 477  * Bits for share access and deny.
 478  */
 479 #define NFSV4OPEN_ACCESSREAD            0x00000001
 480 #define NFSV4OPEN_ACCESSWRITE           0x00000002
 481 #define NFSV4OPEN_ACCESSBOTH            0x00000003
 482
 483 #define NFSV4OPEN_DENYNONE              0x00000000
 484 #define NFSV4OPEN_DENYREAD              0x00000001
 485 #define NFSV4OPEN_DENYWRITE             0x00000002
 486 #define NFSV4OPEN_DENYBOTH              0x00000003
 487
 488 /*
 489  * Open result flags
 490  * (The first two are in the spec. The rest are used internally.)
 491  */
 492 #define NFSV4OPEN_RESULTCONFIRM         0x00000002
 493 #define NFSV4OPEN_LOCKTYPEPOSIX         0x00000004
 494 #define NFSV4OPEN_RFLAGS                                                \
 495                 (NFSV4OPEN_RESULTCONFIRM | NFSV4OPEN_LOCKTYPEPOSIX)
 496 #define NFSV4OPEN_RECALL                0x00010000
 497 #define NFSV4OPEN_READDELEGATE          0x00020000
 498 #define NFSV4OPEN_WRITEDELEGATE         0x00040000
 499
 500 /*
 501  * NFS V4 File Handle types
 502  */
 503 #define NFSV4FHTYPE_PERSISTENT          0x0
 504 #define NFSV4FHTYPE_NOEXPIREWITHOPEN    0x1
 505 #define NFSV4FHTYPE_VOLATILEANY         0x2
 506 #define NFSV4FHTYPE_VOLATILEMIGRATE     0x4
 507 #define NFSV4FHTYPE_VOLATILERENAME      0x8
 508
 509 /*
 510  * Maximum size of V4 opaque strings.
 511  */
 512 #define NFSV4_OPAQUELIMIT       1024
 513
 514 /*
 515  * These are the same for V3 and V4.
 516  */
 517 #define NFSACCESS_READ                  0x01
 518 #define NFSACCESS_LOOKUP                0x02
 519 #define NFSACCESS_MODIFY                0x04
 520 #define NFSACCESS_EXTEND                0x08
 521 #define NFSACCESS_DELETE                0x10
 522 #define NFSACCESS_EXECUTE               0x20
 523
 524 #define NFSWRITE_UNSTABLE               0
 525 #define NFSWRITE_DATASYNC               1
 526 #define NFSWRITE_FILESYNC               2
 527
 528 #define NFSCREATE_UNCHECKED             0
 529 #define NFSCREATE_GUARDED               1
 530 #define NFSCREATE_EXCLUSIVE             2
 531 #define NFSCREATE_EXCLUSIVE41           3
 532
 533 #define NFSV3FSINFO_LINK                0x01
 534 #define NFSV3FSINFO_SYMLINK             0x02
 535 #define NFSV3FSINFO_HOMOGENEOUS         0x08
 536 #define NFSV3FSINFO_CANSETTIME          0x10
 537
 538 /* Flags for Exchange ID */
 539 #define NFSV4EXCH_SUPPMOVEDREFER        0x00000001
 540 #define NFSV4EXCH_SUPPMOVEDMIGR 0x00000002
 541 #define NFSV4EXCH_BINDPRINCSTATEID      0x00000100
 542 #define NFSV4EXCH_USENONPNFS            0x00010000
 543 #define NFSV4EXCH_USEPNFSMDS            0x00020000
 544 #define NFSV4EXCH_USEPNFSDS             0x00040000
 545 #define NFSV4EXCH_MASKPNFS              0x00070000
 546 #define NFSV4EXCH_UPDCONFIRMEDRECA      0x40000000
 547 #define NFSV4EXCH_CONFIRMEDR            0x80000000
 548
 549 /* State Protects */
 550 #define NFSV4EXCH_SP4NONE               0
 551 #define NFSV4EXCH_SP4MACHCRED           1
 552 #define NFSV4EXCH_SP4SSV                2
 553
 554 /* Flags for Create Session */
 555 #define NFSV4CRSESS_PERSIST             0x00000001
 556 #define NFSV4CRSESS_CONNBACKCHAN        0x00000002
 557 #define NFSV4CRSESS_CONNRDMA            0x00000004
 558
 559 /* Flags for Sequence */
 560 #define NFSV4SEQ_CBPATHDOWN             0x00000001
 561 #define NFSV4SEQ_CBGSSCONTEXPIRING      0x00000002
 562 #define NFSV4SEQ_CBGSSCONTEXPIRED       0x00000004
 563 #define NFSV4SEQ_EXPIREDALLSTATEREVOKED 0x00000008
 564 #define NFSV4SEQ_EXPIREDSOMESTATEREVOKED 0x00000010
 565 #define NFSV4SEQ_ADMINSTATEREVOKED      0x00000020
 566 #define NFSV4SEQ_RECALLABLESTATEREVOKED 0x00000040
 567 #define NFSV4SEQ_LEASEMOVED             0x00000080
 568 #define NFSV4SEQ_RESTARTRECLAIMNEEDED   0x00000100
 569 #define NFSV4SEQ_CBPATHDOWNSESSION      0x00000200
 570 #define NFSV4SEQ_BACKCHANNELFAULT       0x00000400
 571 #define NFSV4SEQ_DEVIDCHANGED           0x00000800
 572 #define NFSV4SEQ_DEVIDDELETED           0x00001000
 573
 574 /* Flags for Layout. */
 575 #define NFSLAYOUTRETURN_FILE            1
 576 #define NFSLAYOUTRETURN_FSID            2
 577 #define NFSLAYOUTRETURN_ALL             3
 578
 579 #define NFSLAYOUT_NFSV4_1_FILES         0x1
 580 #define NFSLAYOUT_OSD2_OBJECTS          0x2
 581 #define NFSLAYOUT_BLOCK_VOLUME          0x3
 582
 583 #define NFSLAYOUTIOMODE_READ            1
 584 #define NFSLAYOUTIOMODE_RW              2
 585 #define NFSLAYOUTIOMODE_ANY             3
 586
 587 /* Flags for Get Device Info. */
 588 #define NFSDEVICEIDNOTIFY_CHANGEBIT     0x1
 589 #define NFSDEVICEIDNOTIFY_DELETEBIT     0x2
 590
 591 /* Flags for File Layout. */
 592 #define NFSFLAYUTIL_DENSE               0x1
 593 #define NFSFLAYUTIL_COMMIT_THRU_MDS     0x2
 594
 595 /* Conversion macros */
 596 #define vtonfsv2_mode(t,m)                                              \
 597                 txdr_unsigned(((t) == VFIFO) ? MAKEIMODE(VCHR, (m)) :   \
 598                                 MAKEIMODE((t), (m)))
 599 #define vtonfsv34_mode(m)       txdr_unsigned((m) & 07777)
 600 #define nfstov_mode(a)          (fxdr_unsigned(u_int16_t, (a))&07777)
 601 #define vtonfsv2_type(a)  (((u_int32_t)(a)) >= 9 ? txdr_unsigned(NFNON) : \
 602                 txdr_unsigned(newnfsv2_type[((u_int32_t)(a))]))
 603 #define vtonfsv34_type(a)  (((u_int32_t)(a)) >= 9 ? txdr_unsigned(NFNON) : \
 604                 txdr_unsigned(nfsv34_type[((u_int32_t)(a))]))
 605 #define nfsv2tov_type(a)        newnv2tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
 606 #define nfsv34tov_type(a)       nv34tov_type[fxdr_unsigned(u_int32_t,(a))&0x7]
 607 #define vtonfs_dtype(a) (((u_int32_t)(a)) >= 9 ? IFTODT(VTTOIF(VNON)) : \
 608                          IFTODT(VTTOIF(a)))
 609
 610 /* File types */
 611 typedef enum { NFNON=0, NFREG=1, NFDIR=2, NFBLK=3, NFCHR=4, NFLNK=5,
 612         NFSOCK=6, NFFIFO=7, NFATTRDIR=8, NFNAMEDATTR=9 } nfstype;
 613
 614 /* Structs for common parts of the rpc's */
 615
 616 struct nfsv2_time {
 617         u_int32_t nfsv2_sec;
 618         u_int32_t nfsv2_usec;
 619 };
 620 typedef struct nfsv2_time       nfstime2;
 621
 622 struct nfsv3_time {
 623         u_int32_t nfsv3_sec;
 624         u_int32_t nfsv3_nsec;
 625 };
 626 typedef struct nfsv3_time       nfstime3;
 627
 628 struct nfsv4_time {
 629         u_int32_t nfsv4_highsec;
 630         u_int32_t nfsv4_sec;
 631         u_int32_t nfsv4_nsec;
 632 };
 633 typedef struct nfsv4_time       nfstime4;
 634
 635 /*
 636  * Quads are defined as arrays of 2 longs to ensure dense packing for the
 637  * protocol and to facilitate xdr conversion.
 638  */
 639 struct nfs_uquad {
 640         u_int32_t nfsuquad[2];
 641 };
 642 typedef struct nfs_uquad        nfsuint64;
 643
 644 /*
 645  * Used to convert between two u_longs and a u_quad_t.
 646  */
 647 union nfs_quadconvert {
 648         u_int32_t lval[2];
 649         u_quad_t  qval;
 650 };
 651 typedef union nfs_quadconvert   nfsquad_t;
 652
 653 /*
 654  * NFS Version 3 special file number.
 655  */
 656 struct nfsv3_spec {
 657         u_int32_t specdata1;
 658         u_int32_t specdata2;
 659 };
 660 typedef struct nfsv3_spec       nfsv3spec;
 661
 662 /*
 663  * File attributes and setable attributes. These structures cover both
 664  * NFS version 2 and the version 3 protocol. Note that the union is only
 665  * used so that one pointer can refer to both variants. These structures
 666  * go out on the wire and must be densely packed, so no quad data types
 667  * are used. (all fields are longs or u_longs or structures of same)
 668  * NB: You can't do sizeof(struct nfs_fattr), you must use the
 669  *     NFSX_FATTR(v3) macro.
 670  */
 671 struct nfs_fattr {
 672         u_int32_t fa_type;
 673         u_int32_t fa_mode;
 674         u_int32_t fa_nlink;
 675         u_int32_t fa_uid;
 676         u_int32_t fa_gid;
 677         union {
 678                 struct {
 679                         u_int32_t nfsv2fa_size;
 680                         u_int32_t nfsv2fa_blocksize;
 681                         u_int32_t nfsv2fa_rdev;
 682                         u_int32_t nfsv2fa_blocks;
 683                         u_int32_t nfsv2fa_fsid;
 684                         u_int32_t nfsv2fa_fileid;
 685                         nfstime2  nfsv2fa_atime;
 686                         nfstime2  nfsv2fa_mtime;
 687                         nfstime2  nfsv2fa_ctime;
 688                 } fa_nfsv2;
 689                 struct {
 690                         nfsuint64 nfsv3fa_size;
 691                         nfsuint64 nfsv3fa_used;
 692                         nfsv3spec nfsv3fa_rdev;
 693                         nfsuint64 nfsv3fa_fsid;
 694                         nfsuint64 nfsv3fa_fileid;
 695                         nfstime3  nfsv3fa_atime;
 696                         nfstime3  nfsv3fa_mtime;
 697                         nfstime3  nfsv3fa_ctime;
 698                 } fa_nfsv3;
 699         } fa_un;
 700 };
 701
 702 /* and some ugly defines for accessing union components */
 703 #define fa2_size                fa_un.fa_nfsv2.nfsv2fa_size
 704 #define fa2_blocksize           fa_un.fa_nfsv2.nfsv2fa_blocksize
 705 #define fa2_rdev                fa_un.fa_nfsv2.nfsv2fa_rdev
 706 #define fa2_blocks              fa_un.fa_nfsv2.nfsv2fa_blocks
 707 #define fa2_fsid                fa_un.fa_nfsv2.nfsv2fa_fsid
 708 #define fa2_fileid              fa_un.fa_nfsv2.nfsv2fa_fileid
 709 #define fa2_atime               fa_un.fa_nfsv2.nfsv2fa_atime
 710 #define fa2_mtime               fa_un.fa_nfsv2.nfsv2fa_mtime
 711 #define fa2_ctime               fa_un.fa_nfsv2.nfsv2fa_ctime
 712 #define fa3_size                fa_un.fa_nfsv3.nfsv3fa_size
 713 #define fa3_used                fa_un.fa_nfsv3.nfsv3fa_used
 714 #define fa3_rdev                fa_un.fa_nfsv3.nfsv3fa_rdev
 715 #define fa3_fsid                fa_un.fa_nfsv3.nfsv3fa_fsid
 716 #define fa3_fileid              fa_un.fa_nfsv3.nfsv3fa_fileid
 717 #define fa3_atime               fa_un.fa_nfsv3.nfsv3fa_atime
 718 #define fa3_mtime               fa_un.fa_nfsv3.nfsv3fa_mtime
 719 #define fa3_ctime               fa_un.fa_nfsv3.nfsv3fa_ctime
 720
 721 struct nfsv2_sattr {
 722         u_int32_t sa_mode;
 723         u_int32_t sa_uid;
 724         u_int32_t sa_gid;
 725         u_int32_t sa_size;
 726         nfstime2  sa_atime;
 727         nfstime2  sa_mtime;
 728 };
 729
 730 /*
 731  * NFS Version 3 sattr structure for the new node creation case.
 732  */
 733 struct nfsv3_sattr {
 734         u_int32_t sa_modetrue;
 735         u_int32_t sa_mode;
 736         u_int32_t sa_uidfalse;
 737         u_int32_t sa_gidfalse;
 738         u_int32_t sa_sizefalse;
 739         u_int32_t sa_atimetype;
 740         nfstime3  sa_atime;
 741         u_int32_t sa_mtimetype;
 742         nfstime3  sa_mtime;
 743 };
 744
 745 /*
 746  * The attribute bits used for V4.
 747  * NFSATTRBIT_xxx defines the attribute# (and its bit position)
 748  * NFSATTRBM_xxx is a 32bit mask with the correct bit set within the
 749  *      appropriate 32bit word.
 750  * NFSATTRBIT_MAX is one greater than the largest NFSATTRBIT_xxx
 751  */
 752 #define NFSATTRBIT_SUPPORTEDATTRS       0
 753 #define NFSATTRBIT_TYPE                 1
 754 #define NFSATTRBIT_FHEXPIRETYPE         2
 755 #define NFSATTRBIT_CHANGE               3
 756 #define NFSATTRBIT_SIZE                 4
 757 #define NFSATTRBIT_LINKSUPPORT          5
 758 #define NFSATTRBIT_SYMLINKSUPPORT       6
 759 #define NFSATTRBIT_NAMEDATTR            7
 760 #define NFSATTRBIT_FSID                 8
 761 #define NFSATTRBIT_UNIQUEHANDLES        9
 762 #define NFSATTRBIT_LEASETIME            10
 763 #define NFSATTRBIT_RDATTRERROR          11
 764 #define NFSATTRBIT_ACL                  12
 765 #define NFSATTRBIT_ACLSUPPORT           13
 766 #define NFSATTRBIT_ARCHIVE              14
 767 #define NFSATTRBIT_CANSETTIME           15
 768 #define NFSATTRBIT_CASEINSENSITIVE      16
 769 #define NFSATTRBIT_CASEPRESERVING       17
 770 #define NFSATTRBIT_CHOWNRESTRICTED      18
 771 #define NFSATTRBIT_FILEHANDLE           19
 772 #define NFSATTRBIT_FILEID               20
 773 #define NFSATTRBIT_FILESAVAIL           21
 774 #define NFSATTRBIT_FILESFREE            22
 775 #define NFSATTRBIT_FILESTOTAL           23
 776 #define NFSATTRBIT_FSLOCATIONS          24
 777 #define NFSATTRBIT_HIDDEN               25
 778 #define NFSATTRBIT_HOMOGENEOUS          26
 779 #define NFSATTRBIT_MAXFILESIZE          27
 780 #define NFSATTRBIT_MAXLINK              28
 781 #define NFSATTRBIT_MAXNAME              29
 782 #define NFSATTRBIT_MAXREAD              30
 783 #define NFSATTRBIT_MAXWRITE             31
 784 #define NFSATTRBIT_MIMETYPE             32
 785 #define NFSATTRBIT_MODE                 33
 786 #define NFSATTRBIT_NOTRUNC              34
 787 #define NFSATTRBIT_NUMLINKS             35
 788 #define NFSATTRBIT_OWNER                36
 789 #define NFSATTRBIT_OWNERGROUP           37
 790 #define NFSATTRBIT_QUOTAHARD            38
 791 #define NFSATTRBIT_QUOTASOFT            39
 792 #define NFSATTRBIT_QUOTAUSED            40
 793 #define NFSATTRBIT_RAWDEV               41
 794 #define NFSATTRBIT_SPACEAVAIL           42
 795 #define NFSATTRBIT_SPACEFREE            43
 796 #define NFSATTRBIT_SPACETOTAL           44
 797 #define NFSATTRBIT_SPACEUSED            45
 798 #define NFSATTRBIT_SYSTEM               46
 799 #define NFSATTRBIT_TIMEACCESS           47
 800 #define NFSATTRBIT_TIMEACCESSSET        48
 801 #define NFSATTRBIT_TIMEBACKUP           49
 802 #define NFSATTRBIT_TIMECREATE           50
 803 #define NFSATTRBIT_TIMEDELTA            51
 804 #define NFSATTRBIT_TIMEMETADATA         52
 805 #define NFSATTRBIT_TIMEMODIFY           53
 806 #define NFSATTRBIT_TIMEMODIFYSET        54
 807 #define NFSATTRBIT_MOUNTEDONFILEID      55
 808
 809 #define NFSATTRBM_SUPPORTEDATTRS        0x00000001
 810 #define NFSATTRBM_TYPE                  0x00000002
 811 #define NFSATTRBM_FHEXPIRETYPE          0x00000004
 812 #define NFSATTRBM_CHANGE                0x00000008
 813 #define NFSATTRBM_SIZE                  0x00000010
 814 #define NFSATTRBM_LINKSUPPORT           0x00000020
 815 #define NFSATTRBM_SYMLINKSUPPORT        0x00000040
 816 #define NFSATTRBM_NAMEDATTR             0x00000080
 817 #define NFSATTRBM_FSID                  0x00000100
 818 #define NFSATTRBM_UNIQUEHANDLES         0x00000200
 819 #define NFSATTRBM_LEASETIME             0x00000400
 820 #define NFSATTRBM_RDATTRERROR           0x00000800
 821 #define NFSATTRBM_ACL                   0x00001000
 822 #define NFSATTRBM_ACLSUPPORT            0x00002000
 823 #define NFSATTRBM_ARCHIVE               0x00004000
 824 #define NFSATTRBM_CANSETTIME            0x00008000
 825 #define NFSATTRBM_CASEINSENSITIVE       0x00010000
 826 #define NFSATTRBM_CASEPRESERVING        0x00020000
 827 #define NFSATTRBM_CHOWNRESTRICTED       0x00040000
 828 #define NFSATTRBM_FILEHANDLE            0x00080000
 829 #define NFSATTRBM_FILEID                0x00100000
 830 #define NFSATTRBM_FILESAVAIL            0x00200000
 831 #define NFSATTRBM_FILESFREE             0x00400000
 832 #define NFSATTRBM_FILESTOTAL            0x00800000
 833 #define NFSATTRBM_FSLOCATIONS           0x01000000
 834 #define NFSATTRBM_HIDDEN                0x02000000
 835 #define NFSATTRBM_HOMOGENEOUS           0x04000000
 836 #define NFSATTRBM_MAXFILESIZE           0x08000000
 837 #define NFSATTRBM_MAXLINK               0x10000000
 838 #define NFSATTRBM_MAXNAME               0x20000000
 839 #define NFSATTRBM_MAXREAD               0x40000000
 840 #define NFSATTRBM_MAXWRITE              0x80000000
 841 #define NFSATTRBM_MIMETYPE              0x00000001
 842 #define NFSATTRBM_MODE                  0x00000002
 843 #define NFSATTRBM_NOTRUNC               0x00000004
 844 #define NFSATTRBM_NUMLINKS              0x00000008
 845 #define NFSATTRBM_OWNER                 0x00000010
 846 #define NFSATTRBM_OWNERGROUP            0x00000020
 847 #define NFSATTRBM_QUOTAHARD             0x00000040
 848 #define NFSATTRBM_QUOTASOFT             0x00000080
 849 #define NFSATTRBM_QUOTAUSED             0x00000100
 850 #define NFSATTRBM_RAWDEV                0x00000200
 851 #define NFSATTRBM_SPACEAVAIL            0x00000400
 852 #define NFSATTRBM_SPACEFREE             0x00000800
 853 #define NFSATTRBM_SPACETOTAL            0x00001000
 854 #define NFSATTRBM_SPACEUSED             0x00002000
 855 #define NFSATTRBM_SYSTEM                0x00004000
 856 #define NFSATTRBM_TIMEACCESS            0x00008000
 857 #define NFSATTRBM_TIMEACCESSSET         0x00010000
 858 #define NFSATTRBM_TIMEBACKUP            0x00020000
 859 #define NFSATTRBM_TIMECREATE            0x00040000
 860 #define NFSATTRBM_TIMEDELTA             0x00080000
 861 #define NFSATTRBM_TIMEMETADATA          0x00100000
 862 #define NFSATTRBM_TIMEMODIFY            0x00200000
 863 #define NFSATTRBM_TIMEMODIFYSET         0x00400000
 864 #define NFSATTRBM_MOUNTEDONFILEID       0x00800000
 865
 866 #define NFSATTRBIT_MAX                  56
 867
 868 /*
 869  * Sets of attributes that are supported, by words in the bitmap.
 870  */
 871 /*
 872  * NFSATTRBIT_SUPPORTED - SUPP0 - bits 0<->31
 873  *                        SUPP1 - bits 32<->63
 874  */
 875 #define NFSATTRBIT_SUPP0                                                \
 876         (NFSATTRBM_SUPPORTEDATTRS |                                     \
 877         NFSATTRBM_TYPE |                                                \
 878         NFSATTRBM_FHEXPIRETYPE |                                        \
 879         NFSATTRBM_CHANGE |                                              \
 880         NFSATTRBM_SIZE |                                                \
 881         NFSATTRBM_LINKSUPPORT |                                         \
 882         NFSATTRBM_SYMLINKSUPPORT |                                      \
 883         NFSATTRBM_NAMEDATTR |                                           \
 884         NFSATTRBM_FSID |                                                \
 885         NFSATTRBM_UNIQUEHANDLES |                                       \
 886         NFSATTRBM_LEASETIME |                                           \
 887         NFSATTRBM_RDATTRERROR |                                         \
 888         NFSATTRBM_ACL |                                                 \
 889         NFSATTRBM_ACLSUPPORT |                                          \
 890         NFSATTRBM_CANSETTIME |                                          \
 891         NFSATTRBM_CASEINSENSITIVE |                                     \
 892         NFSATTRBM_CASEPRESERVING |                                      \
 893         NFSATTRBM_CHOWNRESTRICTED |                                     \
 894         NFSATTRBM_FILEHANDLE |                                          \
 895         NFSATTRBM_FILEID |                                              \
 896         NFSATTRBM_FILESAVAIL |                                          \
 897         NFSATTRBM_FILESFREE |                                           \
 898         NFSATTRBM_FILESTOTAL |                                          \
 899         NFSATTRBM_FSLOCATIONS |                                         \
 900         NFSATTRBM_HOMOGENEOUS |                                         \
 901         NFSATTRBM_MAXFILESIZE |                                         \
 902         NFSATTRBM_MAXLINK |                                             \
 903         NFSATTRBM_MAXNAME |                                             \
 904         NFSATTRBM_MAXREAD |                                             \
 905         NFSATTRBM_MAXWRITE)
 906
 907 /*
 908  * NFSATTRBIT_S1 - subset of SUPP1 - OR of the following bits:
 909  */
 910 #define NFSATTRBIT_S1                                                   \
 911         (NFSATTRBM_MODE |                                               \
 912         NFSATTRBM_NOTRUNC |                                             \
 913         NFSATTRBM_NUMLINKS |                                            \
 914         NFSATTRBM_OWNER |                                               \
 915         NFSATTRBM_OWNERGROUP |                                          \
 916         NFSATTRBM_RAWDEV |                                              \
 917         NFSATTRBM_SPACEAVAIL |                                          \
 918         NFSATTRBM_SPACEFREE |                                           \
 919         NFSATTRBM_SPACETOTAL |                                          \
 920         NFSATTRBM_SPACEUSED |                                           \
 921         NFSATTRBM_TIMEACCESS |                                          \
 922         NFSATTRBM_TIMEDELTA |                                           \
 923         NFSATTRBM_TIMEMETADATA |                                        \
 924         NFSATTRBM_TIMEMODIFY |                                          \
 925         NFSATTRBM_MOUNTEDONFILEID)
 926
 927 #ifdef QUOTA
 928 /*
 929  * If QUOTA OR in NFSATTRBIT_QUOTAHARD, NFSATTRBIT_QUOTASOFT and
 930  * NFSATTRBIT_QUOTAUSED.
 931  */
 932 #define NFSATTRBIT_SUPP1        (NFSATTRBIT_S1 |                        \
 933                                 NFSATTRBM_QUOTAHARD |                   \
 934                                 NFSATTRBM_QUOTASOFT |                   \
 935                                 NFSATTRBM_QUOTAUSED)
 936 #else
 937 #define NFSATTRBIT_SUPP1        NFSATTRBIT_S1
 938 #endif
 939
 940 /*
 941  * NFSATTRBIT_SUPPSETONLY is the OR of NFSATTRBIT_TIMEACCESSSET and
 942  * NFSATTRBIT_TIMEMODIFYSET.
 943  */
 944 #define NFSATTRBIT_SUPPSETONLY   (NFSATTRBM_TIMEACCESSSET |             \
 945                                  NFSATTRBM_TIMEMODIFYSET)
 946
 947 /*
 948  * NFSATTRBIT_SETABLE - SETABLE0 - bits 0<->31
 949  *                      SETABLE1 - bits 32<->63
 950  */
 951 #define NFSATTRBIT_SETABLE0                                             \
 952         (NFSATTRBM_SIZE |                                               \
 953         NFSATTRBM_ACL)
 954 #define NFSATTRBIT_SETABLE1                                             \
 955         (NFSATTRBM_MODE |                                               \
 956         NFSATTRBM_OWNER |                                               \
 957         NFSATTRBM_OWNERGROUP |                                          \
 958         NFSATTRBM_TIMEACCESSSET |                                       \
 959         NFSATTRBM_TIMEMODIFYSET)
 960
 961 /*
 962  * Set of attributes that the getattr vnode op needs.
 963  * OR of the following bits.
 964  * NFSATTRBIT_GETATTR0 - bits 0<->31
 965  */
 966 #define NFSATTRBIT_GETATTR0                                             \
 967         (NFSATTRBM_SUPPORTEDATTRS |                                     \
 968         NFSATTRBM_TYPE |                                                \
 969         NFSATTRBM_CHANGE |                                              \
 970         NFSATTRBM_SIZE |                                                \
 971         NFSATTRBM_FSID |                                                \
 972         NFSATTRBM_FILEID |                                              \
 973         NFSATTRBM_MAXREAD)
 974
 975 /*
 976  * NFSATTRBIT_GETATTR1 - bits 32<->63
 977  */
 978 #define NFSATTRBIT_GETATTR1                                             \
 979         (NFSATTRBM_MODE |                                               \
 980         NFSATTRBM_NUMLINKS |                                            \
 981         NFSATTRBM_OWNER |                                               \
 982         NFSATTRBM_OWNERGROUP |                                          \
 983         NFSATTRBM_RAWDEV |                                              \
 984         NFSATTRBM_SPACEUSED |                                           \
 985         NFSATTRBM_TIMEACCESS |                                          \
 986         NFSATTRBM_TIMEMETADATA |                                        \
 987         NFSATTRBM_TIMEMODIFY)
 988
 989 /*
 990  * Subset of the above that the Write RPC gets.
 991  * OR of the following bits.
 992  * NFSATTRBIT_WRITEGETATTR0 - bits 0<->31
 993  */
 994 #define NFSATTRBIT_WRITEGETATTR0                                        \
 995         (NFSATTRBM_SUPPORTEDATTRS |                                     \
 996         NFSATTRBM_TYPE |                                                \
 997         NFSATTRBM_CHANGE |                                              \
 998         NFSATTRBM_SIZE |                                                \
 999         NFSATTRBM_FSID |                                                \
1000         NFSATTRBM_FILEID |                                              \
1001         NFSATTRBM_MAXREAD)
1002
1003 /*
1004  * NFSATTRBIT_WRITEGETATTR1 - bits 32<->63
1005  */
1006 #define NFSATTRBIT_WRITEGETATTR1                                        \
1007         (NFSATTRBM_MODE |                                               \
1008         NFSATTRBM_NUMLINKS |                                            \
1009         NFSATTRBM_RAWDEV |                                              \
1010         NFSATTRBM_SPACEUSED |                                           \
1011         NFSATTRBM_TIMEACCESS |                                          \
1012         NFSATTRBM_TIMEMETADATA |                                        \
1013         NFSATTRBM_TIMEMODIFY)
1014
1015 /*
1016  * Set of attributes that the wccattr operation op needs.
1017  * OR of the following bits.
1018  * NFSATTRBIT_WCCATTR0 - bits 0<->31
1019  */
1020 #define NFSATTRBIT_WCCATTR0     0
1021
1022 /*
1023  * NFSATTRBIT_WCCATTR1 - bits 32<->63
1024  */
1025 #define NFSATTRBIT_WCCATTR1                                             \
1026         (NFSATTRBM_TIMEMODIFY)
1027
1028 /*
1029  * NFSATTRBIT_CBGETATTR0 - bits 0<->31
1030  */
1031 #define NFSATTRBIT_CBGETATTR0   (NFSATTRBM_CHANGE | NFSATTRBM_SIZE)
1032
1033 /*
1034  * NFSATTRBIT_CBGETATTR1 - bits 32<->63
1035  */
1036 #define NFSATTRBIT_CBGETATTR1           0x0
1037
1038 /*
1039  * Sets of attributes that require a VFS_STATFS() call to get the
1040  * values of.
1041  * NFSATTRBIT_STATFS0 - bits 0<->31
1042  */
1043 #define NFSATTRBIT_STATFS0                                              \
1044         (NFSATTRBM_LINKSUPPORT |                                        \
1045         NFSATTRBM_SYMLINKSUPPORT |                                      \
1046         NFSATTRBM_CANSETTIME |                                          \
1047         NFSATTRBM_FILESAVAIL |                                          \
1048         NFSATTRBM_FILESFREE |                                           \
1049         NFSATTRBM_FILESTOTAL |                                          \
1050         NFSATTRBM_HOMOGENEOUS |                                         \
1051         NFSATTRBM_MAXFILESIZE |                                         \
1052         NFSATTRBM_MAXNAME |                                             \
1053         NFSATTRBM_MAXREAD |                                             \
1054         NFSATTRBM_MAXWRITE)
1055
1056 /*
1057  * NFSATTRBIT_STATFS1 - bits 32<->63
1058  */
1059 #define NFSATTRBIT_STATFS1                                              \
1060         (NFSATTRBM_QUOTAHARD |                                          \
1061         NFSATTRBM_QUOTASOFT |                                           \
1062         NFSATTRBM_QUOTAUSED |                                           \
1063         NFSATTRBM_SPACEAVAIL |                                          \
1064         NFSATTRBM_SPACEFREE |                                           \
1065         NFSATTRBM_SPACETOTAL |                                          \
1066         NFSATTRBM_SPACEUSED |                                           \
1067         NFSATTRBM_TIMEDELTA)
1068
1069 /*
1070  * These are the bits that are needed by the nfs_statfs() call.
1071  * (The regular getattr bits are or'd in so the vnode gets the correct
1072  *  type, etc.)
1073  * NFSGETATTRBIT_STATFS0 - bits 0<->31
1074  */
1075 #define NFSGETATTRBIT_STATFS0   (NFSATTRBIT_GETATTR0 |                  \
1076                                 NFSATTRBM_LINKSUPPORT |                 \
1077                                 NFSATTRBM_SYMLINKSUPPORT |              \
1078                                 NFSATTRBM_CANSETTIME |                  \
1079                                 NFSATTRBM_FILESFREE |                   \
1080                                 NFSATTRBM_FILESTOTAL |                  \
1081                                 NFSATTRBM_HOMOGENEOUS |                 \
1082                                 NFSATTRBM_MAXFILESIZE |                 \
1083                                 NFSATTRBM_MAXNAME |                     \
1084                                 NFSATTRBM_MAXREAD |                     \
1085                                 NFSATTRBM_MAXWRITE)
1086
1087 /*
1088  * NFSGETATTRBIT_STATFS1 - bits 32<->63
1089  */
1090 #define NFSGETATTRBIT_STATFS1   (NFSATTRBIT_GETATTR1 |                  \
1091                                 NFSATTRBM_SPACEAVAIL |                  \
1092                                 NFSATTRBM_SPACEFREE |                   \
1093                                 NFSATTRBM_SPACETOTAL |                  \
1094                                 NFSATTRBM_TIMEDELTA)
1095
1096 /*
1097  * Set of attributes for the equivalent of an nfsv3 pathconf rpc.
1098  * NFSGETATTRBIT_PATHCONF0 - bits 0<->31
1099  */
1100 #define NFSGETATTRBIT_PATHCONF0 (NFSATTRBIT_GETATTR0 |                  \
1101                                 NFSATTRBM_CASEINSENSITIVE |             \
1102                                 NFSATTRBM_CASEPRESERVING |              \
1103                                 NFSATTRBM_CHOWNRESTRICTED |             \
1104                                 NFSATTRBM_MAXLINK |                     \
1105                                 NFSATTRBM_MAXNAME)
1106
1107 /*
1108  * NFSGETATTRBIT_PATHCONF1 - bits 32<->63
1109  */
1110 #define NFSGETATTRBIT_PATHCONF1 (NFSATTRBIT_GETATTR1 |                  \
1111                                 NFSATTRBM_NOTRUNC)
1112
1113 /*
1114  * Sets of attributes required by readdir and readdirplus.
1115  * NFSATTRBIT_READDIRPLUS0      (NFSATTRBIT_GETATTR0 | NFSATTRBIT_FILEHANDLE |
1116  *                               NFSATTRBIT_RDATTRERROR)
1117  */
1118 #define NFSATTRBIT_READDIRPLUS0 (NFSATTRBIT_GETATTR0 | NFSATTRBM_FILEHANDLE | \
1119                                 NFSATTRBM_RDATTRERROR)
1120 #define NFSATTRBIT_READDIRPLUS1 NFSATTRBIT_GETATTR1
1121
1122 /*
1123  * Set of attributes supported by Referral vnodes.
1124  */
1125 #define NFSATTRBIT_REFERRAL0    (NFSATTRBM_TYPE | NFSATTRBM_FSID |      \
1126         NFSATTRBM_RDATTRERROR | NFSATTRBM_FSLOCATIONS)
1127 #define NFSATTRBIT_REFERRAL1    NFSATTRBM_MOUNTEDONFILEID
1128
1129 /*
1130  * Structure for data handled by the statfs rpc. Since some fields are
1131  * u_int64_t, this cannot be used for copying data on/off the wire, due
1132  * to alignment concerns.
1133  */
1134 struct nfsstatfs {
1135         union {
1136                 struct {
1137                         u_int32_t nfsv2sf_tsize;
1138                         u_int32_t nfsv2sf_bsize;
1139                         u_int32_t nfsv2sf_blocks;
1140                         u_int32_t nfsv2sf_bfree;
1141                         u_int32_t nfsv2sf_bavail;
1142                 } sf_nfsv2;
1143                 struct {
1144                         u_int64_t nfsv3sf_tbytes;
1145                         u_int64_t nfsv3sf_fbytes;
1146                         u_int64_t nfsv3sf_abytes;
1147                         u_int64_t nfsv3sf_tfiles;
1148                         u_int64_t nfsv3sf_ffiles;
1149                         u_int64_t nfsv3sf_afiles;
1150                         u_int32_t nfsv3sf_invarsec;
1151                 } sf_nfsv3;
1152         } sf_un;
1153 };
1154
1155 #define sf_tsize        sf_un.sf_nfsv2.nfsv2sf_tsize
1156 #define sf_bsize        sf_un.sf_nfsv2.nfsv2sf_bsize
1157 #define sf_blocks       sf_un.sf_nfsv2.nfsv2sf_blocks
1158 #define sf_bfree        sf_un.sf_nfsv2.nfsv2sf_bfree
1159 #define sf_bavail       sf_un.sf_nfsv2.nfsv2sf_bavail
1160 #define sf_tbytes       sf_un.sf_nfsv3.nfsv3sf_tbytes
1161 #define sf_fbytes       sf_un.sf_nfsv3.nfsv3sf_fbytes
1162 #define sf_abytes       sf_un.sf_nfsv3.nfsv3sf_abytes
1163 #define sf_tfiles       sf_un.sf_nfsv3.nfsv3sf_tfiles
1164 #define sf_ffiles       sf_un.sf_nfsv3.nfsv3sf_ffiles
1165 #define sf_afiles       sf_un.sf_nfsv3.nfsv3sf_afiles
1166 #define sf_invarsec     sf_un.sf_nfsv3.nfsv3sf_invarsec
1167
1168 /*
1169  * Now defined using u_int64_t for the 64 bit field(s).
1170  * (Cannot be used to move data on/off the wire, due to alignment concerns.)
1171  */
1172 struct nfsfsinfo {
1173         u_int32_t fs_rtmax;
1174         u_int32_t fs_rtpref;
1175         u_int32_t fs_rtmult;
1176         u_int32_t fs_wtmax;
1177         u_int32_t fs_wtpref;
1178         u_int32_t fs_wtmult;
1179         u_int32_t fs_dtpref;
1180         u_int64_t fs_maxfilesize;
1181         struct timespec fs_timedelta;
1182         u_int32_t fs_properties;
1183 };
1184
1185 /*
1186  * Bits for fs_properties
1187  */
1188 #define NFSV3_FSFLINK           0x1
1189 #define NFSV3_FSFSYMLINK        0x2
1190 #define NFSV3_FSFHOMOGENEOUS    0x4
1191 #define NFSV3_FSFCANSETTIME     0x8
1192
1193 /*
1194  * Yikes, overload fs_rtmult as fs_maxname for V4.
1195  */
1196 #define fs_maxname      fs_rtmult
1197
1198 struct nfsv3_pathconf {
1199         u_int32_t pc_linkmax;
1200         u_int32_t pc_namemax;
1201         u_int32_t pc_notrunc;
1202         u_int32_t pc_chownrestricted;
1203         u_int32_t pc_caseinsensitive;
1204         u_int32_t pc_casepreserving;
1205 };
1206
1207 /*
1208  * NFS V4 data structures.
1209  */
1210 struct nfsv4stateid {
1211         u_int32_t       seqid;
1212         u_int32_t       other[NFSX_STATEIDOTHER / NFSX_UNSIGNED];
1213 };
1214 typedef struct nfsv4stateid nfsv4stateid_t;
1215
1216 #endif  /* _NFS_NFSPROTO_H_ */