sys/fs/nfs/nfs.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1989, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to Berkeley by
   8  * Rick Macklem at The University of Guelph.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  * 1. Redistributions of source code must retain the above copyright
  14  *    notice, this list of conditions and the following disclaimer.
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the distribution.
  18  * 3. Neither the name of the University nor the names of its contributors
  19  *    may be used to endorse or promote products derived from this software
  20  *    without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  32  * SUCH DAMAGE.
  33  *
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _NFS_NFS_H_
  38 #define _NFS_NFS_H_
  39 /*
  40  * Tunable constants for nfs
  41  */
  42
  43 #define NFS_MAXIOVEC    34
  44 #define NFS_TICKINTVL   500             /* Desired time for a tick (msec) */
  45 #define NFS_HZ          (hz / nfscl_ticks) /* Ticks/sec */
  46 #define NFS_TIMEO       (1 * NFS_HZ)    /* Default timeout = 1 second */
  47 #define NFS_MINTIMEO    (1 * NFS_HZ)    /* Min timeout to use */
  48 #define NFS_MAXTIMEO    (60 * NFS_HZ)   /* Max timeout to backoff to */
  49 #define NFS_TCPTIMEO    300             /* TCP timeout */
  50 #define NFS_MAXRCVTIMEO 60              /* 1 minute in seconds */
  51 #define NFS_MINIDEMTIMEO (5 * NFS_HZ)   /* Min timeout for non-idempotent ops*/
  52 #define NFS_MAXREXMIT   100             /* Stop counting after this many */
  53 #define NFSV4_CALLBACKTIMEO (2 * NFS_HZ) /* Timeout in ticks */
  54 #define NFSV4_CALLBACKRETRY 5           /* Number of retries before failure */
  55 #define NFSV4_SLOTS     64              /* Number of slots, fore channel */
  56 #define NFSV4_CBSLOTS   8               /* Number of slots, back channel */
  57 #define NFSV4_CBRETRYCNT 4              /* # of CBRecall retries upon err */
  58 #define NFSV4_UPCALLTIMEO (15 * NFS_HZ) /* Timeout in ticks for upcalls */
  59                                         /* to gssd or nfsuserd */
  60 #define NFSV4_UPCALLRETRY 4             /* Number of retries before failure */
  61 #define NFS_MAXWINDOW   1024            /* Max number of outstanding requests */
  62 #define NFS_RETRANS     10              /* Num of retrans for soft mounts */
  63 #define NFS_RETRANS_TCP 2               /* Num of retrans for TCP soft mounts */
  64 #define NFS_MAXGRPS     16              /* Max. size of groups list */
  65 #define NFS_TRYLATERDEL 15              /* Maximum delay timeout (sec) */
  66 #ifndef NFS_REMOVETIMEO
  67 #define NFS_REMOVETIMEO 15  /* # sec to wait for delegret in local syscall */
  68 #endif
  69 #ifndef NFS_MINATTRTIMO
  70 #define NFS_MINATTRTIMO 5               /* Attribute cache timeout in sec */
  71 #endif
  72 #ifndef NFS_MAXATTRTIMO
  73 #define NFS_MAXATTRTIMO 60
  74 #endif
  75 #define NFS_WSIZE       8192            /* Def. write data size <= 8192 */
  76 #define NFS_RSIZE       8192            /* Def. read data size <= 8192 */
  77 #define NFS_READDIRSIZE 8192            /* Def. readdir size */
  78 #define NFS_DEFRAHEAD   1               /* Def. read ahead # blocks */
  79 #define NFS_MAXRAHEAD   16              /* Max. read ahead # blocks */
  80 #define NFS_MAXASYNCDAEMON      64      /* Max. number async_daemons runnable */
  81 #define NFS_MAXUIDHASH  64              /* Max. # of hashed uid entries/mp */
  82 #ifndef NFSRV_LEASE
  83 #define NFSRV_LEASE             120     /* Lease time in seconds for V4 */
  84 #endif                                  /* assigned to nfsrv_lease */
  85 #ifndef NFSRV_STALELEASE
  86 #define NFSRV_STALELEASE        (5 * nfsrv_lease)
  87 #endif
  88 #ifndef NFSRV_MOULDYLEASE
  89 #define NFSRV_MOULDYLEASE       604800  /* One week (in sec) */
  90 #endif
  91 #ifndef NFSCLIENTHASHSIZE
  92 #define NFSCLIENTHASHSIZE       20      /* Size of server client hash table */
  93 #endif
  94 #ifndef NFSLOCKHASHSIZE
  95 #define NFSLOCKHASHSIZE         20      /* Size of server nfslock hash table */
  96 #endif
  97 #ifndef NFSSESSIONHASHSIZE
  98 #define NFSSESSIONHASHSIZE      20      /* Size of server session hash table */
  99 #endif
 100 #define NFSSTATEHASHSIZE        10      /* Size of server stateid hash table */
 101 #define NFSLAYOUTHIGHWATER      1000000 /* Upper limit for # of layouts */
 102 #ifndef NFSCLDELEGHIGHWATER
 103 #define NFSCLDELEGHIGHWATER     10000   /* limit for client delegations */
 104 #endif
 105 #ifndef NFSCLLAYOUTHIGHWATER
 106 #define NFSCLLAYOUTHIGHWATER    10000   /* limit for client pNFS layouts */
 107 #endif
 108 #ifndef NFSNOOPEN                       /* Inactive open owner (sec) */
 109 #define NFSNOOPEN               120
 110 #endif
 111 #define NFSRV_LEASEDELTA        15      /* # of seconds to delay beyond lease */
 112 #define NFS_IDMAXSIZE           4       /* max sizeof (in_addr_t) */
 113 #ifndef NFSRVCACHE_UDPTIMEOUT
 114 #define NFSRVCACHE_UDPTIMEOUT   30      /* # of sec to hold cached rpcs(udp) */
 115 #endif
 116 #ifndef NFSRVCACHE_UDPHIGHWATER
 117 #define NFSRVCACHE_UDPHIGHWATER 500     /* Max # of udp cache entries */
 118 #endif
 119 #ifndef NFSRVCACHE_TCPTIMEOUT
 120 #define NFSRVCACHE_TCPTIMEOUT   (3600*12) /*#of sec to hold cached rpcs(tcp) */
 121 #endif
 122 #ifndef NFSRVCACHE_FLOODLEVEL
 123 #define NFSRVCACHE_FLOODLEVEL   16384   /* Very high water mark for cache */
 124 #endif
 125 #ifndef NFSRV_CLIENTHIGHWATER
 126 #define NFSRV_CLIENTHIGHWATER   1000
 127 #endif
 128 #ifndef NFSRV_MAXDUMPLIST
 129 #define NFSRV_MAXDUMPLIST       10000
 130 #endif
 131 #ifndef NFS_ACCESSCACHESIZE
 132 #define NFS_ACCESSCACHESIZE     8
 133 #endif
 134 #define NFSV4_CBPORT    7745            /* Callback port for testing */
 135
 136 /*
 137  * This macro defines the high water mark for issuing V4 delegations.
 138  * (It is currently set at a conservative 20% of nfsrv_v4statelimit. This
 139  *  may want to increase when clients can make more effective use of
 140  *  delegations.)
 141  */
 142 #define NFSRV_V4DELEGLIMIT(c) (((c) * 5) > nfsrv_v4statelimit)
 143
 144 #define NFS_READDIRBLKSIZ       DIRBLKSIZ       /* Minimal nm_readdirsize */
 145
 146 /*
 147  * Oddballs
 148  */
 149 #define NFS_CMPFH(n, f, s)                                              \
 150     ((n)->n_fhp->nfh_len == (s) && !NFSBCMP((n)->n_fhp->nfh_fh, (caddr_t)(f), (s)))
 151 #define NFSRV_CMPFH(nf, ns, f, s)                                       \
 152         ((ns) == (s) && !NFSBCMP((caddr_t)(nf), (caddr_t)(f), (s)))
 153 #define NFS_CMPTIME(t1, t2)                                             \
 154         ((t1).tv_sec == (t2).tv_sec && (t1).tv_nsec == (t2).tv_nsec)
 155 #define NFS_SETTIME(t) do {                                             \
 156         (t).tv_sec = time.tv_sec; (t).tv_nsec = 1000 * time.tv_usec; } while (0)
 157 #define NFS_SRVMAXDATA(n)                                               \
 158                 (((n)->nd_flag & (ND_NFSV3 | ND_NFSV4)) ?               \
 159                  NFS_SRVMAXIO : NFS_V2MAXDATA)
 160 #define NFS64BITSSET    0xffffffffffffffffull
 161 #define NFS64BITSMINUS1 0xfffffffffffffffeull
 162
 163 /*
 164  * Structures for the nfssvc(2) syscall. Not that anyone but nfsd, mount_nfs
 165  * and nfsloaduser should ever try and use it.
 166  */
 167 struct nfsd_addsock_args {
 168         int     sock;           /* Socket to serve */
 169         caddr_t name;           /* Client addr for connection based sockets */
 170         int     namelen;        /* Length of name */
 171 };
 172
 173 /*
 174  * nfsd argument for new krpc.
 175  * (New version supports pNFS, indicated by NFSSVC_NEWSTRUCT flag.)
 176  */
 177 struct nfsd_nfsd_args {
 178         const char *principal;  /* GSS-API service principal name */
 179         int     minthreads;     /* minimum service thread count */
 180         int     maxthreads;     /* maximum service thread count */
 181         int     version;        /* Allow multiple variants */
 182         char    *addr;          /* pNFS DS addresses */
 183         int     addrlen;        /* Length of addrs */
 184         char    *dnshost;       /* DNS names for DS addresses */
 185         int     dnshostlen;     /* Length of DNS names */
 186         char    *dspath;        /* DS Mount path on MDS */
 187         int     dspathlen;      /* Length of DS Mount path on MDS */
 188         char    *mdspath;       /* MDS mount for DS path on MDS */
 189         int     mdspathlen;     /* Length of MDS mount for DS path on MDS */
 190         int     mirrorcnt;      /* Number of mirrors to create on DSs */
 191 };
 192
 193 /*
 194  * NFSDEV_MAXMIRRORS - Maximum level of mirroring for a DS.
 195  * (Most will only put files on two DSs, but this setting allows up to 4.)
 196  * NFSDEV_MAXVERS - maximum number of NFS versions supported by Flex File.
 197  */
 198 #define NFSDEV_MAXMIRRORS       4
 199 #define NFSDEV_MAXVERS          4
 200
 201 struct nfsd_pnfsd_args {
 202         int     op;             /* Which pNFSd op to perform. */
 203         char    *mdspath;       /* Path of MDS file. */
 204         char    *dspath;        /* Path of recovered DS mounted on dir. */
 205         char    *curdspath;     /* Path of current DS mounted on dir. */
 206 };
 207
 208 #define PNFSDOP_DELDSSERVER     1
 209 #define PNFSDOP_COPYMR          2
 210 #define PNFSDOP_FORCEDELDS      3
 211
 212 /* Old version. */
 213 struct nfsd_nfsd_oargs {
 214         const char *principal;  /* GSS-API service principal name */
 215         int     minthreads;     /* minimum service thread count */
 216         int     maxthreads;     /* maximum service thread count */
 217 };
 218
 219 /*
 220  * Arguments for use by the callback daemon.
 221  */
 222 struct nfsd_nfscbd_args {
 223         const char *principal;  /* GSS-API service principal name */
 224 };
 225
 226 struct nfscbd_args {
 227         int     sock;           /* Socket to serve */
 228         caddr_t name;           /* Client addr for connection based sockets */
 229         int     namelen;        /* Length of name */
 230         u_short port;           /* Port# for callbacks */
 231 };
 232
 233 struct nfsd_idargs {
 234         int             nid_flag;       /* Flags (see below) */
 235         uid_t           nid_uid;        /* user/group id */
 236         gid_t           nid_gid;
 237         int             nid_usermax;    /* Upper bound on user name cache */
 238         int             nid_usertimeout;/* User name timeout (minutes) */
 239         u_char          *nid_name;      /* Name */
 240         int             nid_namelen;    /* and its length */
 241         gid_t           *nid_grps;      /* and the list */
 242         int             nid_ngroup;     /* Size of groups list */
 243 };
 244
 245 struct nfsd_oidargs {
 246         int             nid_flag;       /* Flags (see below) */
 247         uid_t           nid_uid;        /* user/group id */
 248         gid_t           nid_gid;
 249         int             nid_usermax;    /* Upper bound on user name cache */
 250         int             nid_usertimeout;/* User name timeout (minutes) */
 251         u_char          *nid_name;      /* Name */
 252         int             nid_namelen;    /* and its length */
 253 };
 254
 255 struct nfsd_clid {
 256         int             nclid_idlen;    /* Length of client id */
 257         u_char          nclid_id[NFSV4_OPAQUELIMIT]; /* and name */
 258 };
 259
 260 struct nfsd_dumplist {
 261         int             ndl_size;       /* Number of elements */
 262         void            *ndl_list;      /* and the list of elements */
 263 };
 264
 265 struct nfsd_dumpclients {
 266         u_int32_t       ndcl_flags;             /* LCL_xxx flags */
 267         u_int32_t       ndcl_nopenowners;       /* Number of openowners */
 268         u_int32_t       ndcl_nopens;            /* and opens */
 269         u_int32_t       ndcl_nlockowners;       /* and of lockowners */
 270         u_int32_t       ndcl_nlocks;            /* and of locks */
 271         u_int32_t       ndcl_ndelegs;           /* and of delegations */
 272         u_int32_t       ndcl_nolddelegs;        /* and old delegations */
 273         sa_family_t     ndcl_addrfam;           /* Callback address */
 274         union {
 275                 struct in_addr sin_addr;
 276                 struct in6_addr sin6_addr;
 277         } ndcl_cbaddr;
 278         struct nfsd_clid ndcl_clid;     /* and client id */
 279 };
 280
 281 struct nfsd_dumplocklist {
 282         char            *ndllck_fname;  /* File Name */
 283         int             ndllck_size;    /* Number of elements */
 284         void            *ndllck_list;   /* and the list of elements */
 285 };
 286
 287 struct nfsd_dumplocks {
 288         u_int32_t       ndlck_flags;            /* state flags NFSLCK_xxx */
 289         nfsv4stateid_t  ndlck_stateid;          /* stateid */
 290         u_int64_t       ndlck_first;            /* lock byte range */
 291         u_int64_t       ndlck_end;
 292         struct nfsd_clid ndlck_owner;           /* Owner of open/lock */
 293         sa_family_t     ndlck_addrfam;          /* Callback address */
 294         union {
 295                 struct in_addr sin_addr;
 296                 struct in6_addr sin6_addr;
 297         } ndlck_cbaddr;
 298         struct nfsd_clid ndlck_clid;    /* and client id */
 299 };
 300
 301 /*
 302  * Structure for referral information.
 303  */
 304 struct nfsreferral {
 305         u_char          *nfr_srvlist;   /* List of servers */
 306         int             nfr_srvcnt;     /* number of servers */
 307         vnode_t         nfr_vp; /* vnode for referral */
 308         uint64_t        nfr_dfileno;    /* assigned dir inode# */
 309 };
 310
 311 /*
 312  * Flags for lc_flags and opsflags for nfsrv_getclient().
 313  */
 314 #define LCL_NEEDSCONFIRM        0x00000001
 315 #define LCL_DONTCLEAN           0x00000002
 316 #define LCL_WAKEUPWANTED        0x00000004
 317 #define LCL_TCPCALLBACK         0x00000008
 318 #define LCL_CALLBACKSON         0x00000010
 319 #define LCL_INDEXNOTOK          0x00000020
 320 #define LCL_STAMPEDSTABLE       0x00000040
 321 #define LCL_EXPIREIT            0x00000080
 322 #define LCL_CBDOWN              0x00000100
 323 #define LCL_KERBV               0x00000400
 324 #define LCL_NAME                0x00000800
 325 #define LCL_NEEDSCBNULL         0x00001000
 326 #define LCL_GSSINTEGRITY        0x00002000
 327 #define LCL_GSSPRIVACY          0x00004000
 328 #define LCL_ADMINREVOKED        0x00008000
 329 #define LCL_RECLAIMCOMPLETE     0x00010000
 330 #define LCL_NFSV41              0x00020000
 331 #define LCL_DONEBINDCONN        0x00040000
 332 #define LCL_RECLAIMONEFS        0x00080000
 333
 334 #define LCL_GSS         LCL_KERBV       /* Or of all mechs */
 335
 336 /*
 337  * Bits for flags in nfslock and nfsstate.
 338  * The access, deny, NFSLCK_READ and NFSLCK_WRITE bits must be defined as
 339  * below, in the correct order, so the shifts work for tests.
 340  */
 341 #define NFSLCK_READACCESS       0x00000001
 342 #define NFSLCK_WRITEACCESS      0x00000002
 343 #define NFSLCK_ACCESSBITS       (NFSLCK_READACCESS | NFSLCK_WRITEACCESS)
 344 #define NFSLCK_SHIFT            2
 345 #define NFSLCK_READDENY         0x00000004
 346 #define NFSLCK_WRITEDENY        0x00000008
 347 #define NFSLCK_DENYBITS         (NFSLCK_READDENY | NFSLCK_WRITEDENY)
 348 #define NFSLCK_SHAREBITS                                                \
 349     (NFSLCK_READACCESS|NFSLCK_WRITEACCESS|NFSLCK_READDENY|NFSLCK_WRITEDENY)
 350 #define NFSLCK_LOCKSHIFT        4
 351 #define NFSLCK_READ             0x00000010
 352 #define NFSLCK_WRITE            0x00000020
 353 #define NFSLCK_BLOCKING         0x00000040
 354 #define NFSLCK_RECLAIM          0x00000080
 355 #define NFSLCK_OPENTOLOCK       0x00000100
 356 #define NFSLCK_TEST             0x00000200
 357 #define NFSLCK_LOCK             0x00000400
 358 #define NFSLCK_UNLOCK           0x00000800
 359 #define NFSLCK_OPEN             0x00001000
 360 #define NFSLCK_CLOSE            0x00002000
 361 #define NFSLCK_CHECK            0x00004000
 362 #define NFSLCK_RELEASE          0x00008000
 363 #define NFSLCK_NEEDSCONFIRM     0x00010000
 364 #define NFSLCK_CONFIRM          0x00020000
 365 #define NFSLCK_DOWNGRADE        0x00040000
 366 #define NFSLCK_DELEGREAD        0x00080000
 367 #define NFSLCK_DELEGWRITE       0x00100000
 368 #define NFSLCK_DELEGCUR         0x00200000
 369 #define NFSLCK_DELEGPREV        0x00400000
 370 #define NFSLCK_OLDDELEG         0x00800000
 371 #define NFSLCK_DELEGRECALL      0x01000000
 372 #define NFSLCK_SETATTR          0x02000000
 373 #define NFSLCK_DELEGPURGE       0x04000000
 374 #define NFSLCK_DELEGRETURN      0x08000000
 375 #define NFSLCK_WANTWDELEG       0x10000000
 376 #define NFSLCK_WANTRDELEG       0x20000000
 377 #define NFSLCK_WANTNODELEG      0x40000000
 378 #define NFSLCK_WANTBITS                                                 \
 379     (NFSLCK_WANTWDELEG | NFSLCK_WANTRDELEG | NFSLCK_WANTNODELEG)
 380
 381 /* And bits for nid_flag */
 382 #define NFSID_INITIALIZE        0x0001
 383 #define NFSID_ADDUID            0x0002
 384 #define NFSID_DELUID            0x0004
 385 #define NFSID_ADDUSERNAME       0x0008
 386 #define NFSID_DELUSERNAME       0x0010
 387 #define NFSID_ADDGID            0x0020
 388 #define NFSID_DELGID            0x0040
 389 #define NFSID_ADDGROUPNAME      0x0080
 390 #define NFSID_DELGROUPNAME      0x0100
 391
 392 /*
 393  * fs.nfs sysctl(3) identifiers
 394  */
 395 #define NFS_NFSSTATS    1               /* struct: struct nfsstats */
 396
 397 /*
 398  * Here is the definition of the attribute bits array and macros that
 399  * manipulate it.
 400  * THE MACROS MUST BE MANUALLY MODIFIED IF NFSATTRBIT_MAXWORDS CHANGES!!
 401  * It is (NFSATTRBIT_MAX + 31) / 32.
 402  */
 403 #define NFSATTRBIT_MAXWORDS     3
 404
 405 typedef struct {
 406         u_int32_t bits[NFSATTRBIT_MAXWORDS];
 407 } nfsattrbit_t;
 408
 409 #define NFSZERO_ATTRBIT(b) do {                                         \
 410         (b)->bits[0] = 0;                                               \
 411         (b)->bits[1] = 0;                                               \
 412         (b)->bits[2] = 0;                                               \
 413 } while (0)
 414
 415 #define NFSSET_ATTRBIT(t, f) do {                                       \
 416         (t)->bits[0] = (f)->bits[0];                                    \
 417         (t)->bits[1] = (f)->bits[1];                                    \
 418         (t)->bits[2] = (f)->bits[2];                                    \
 419 } while (0)
 420
 421 #define NFSSETSUPP_ATTRBIT(b) do {                                      \
 422         (b)->bits[0] = NFSATTRBIT_SUPP0;                                \
 423         (b)->bits[1] = (NFSATTRBIT_SUPP1 | NFSATTRBIT_SUPPSETONLY);     \
 424         (b)->bits[2] = NFSATTRBIT_SUPP2;                                \
 425 } while (0)
 426
 427 #define NFSISSET_ATTRBIT(b, p)  ((b)->bits[(p) / 32] & (1 << ((p) % 32)))
 428 #define NFSSETBIT_ATTRBIT(b, p) ((b)->bits[(p) / 32] |= (1 << ((p) % 32)))
 429 #define NFSCLRBIT_ATTRBIT(b, p) ((b)->bits[(p) / 32] &= ~(1 << ((p) % 32)))
 430
 431 #define NFSCLRALL_ATTRBIT(b, a) do {                                    \
 432         (b)->bits[0] &= ~((a)->bits[0]);                                \
 433         (b)->bits[1] &= ~((a)->bits[1]);                                \
 434         (b)->bits[2] &= ~((a)->bits[2]);                                \
 435 } while (0)
 436
 437 #define NFSCLRNOT_ATTRBIT(b, a) do {                                    \
 438         (b)->bits[0] &= ((a)->bits[0]);                                 \
 439         (b)->bits[1] &= ((a)->bits[1]);                                 \
 440         (b)->bits[2] &= ((a)->bits[2]);                                 \
 441 } while (0)
 442
 443 #define NFSCLRNOTFILLABLE_ATTRBIT(b) do {                               \
 444         (b)->bits[0] &= NFSATTRBIT_SUPP0;                               \
 445         (b)->bits[1] &= NFSATTRBIT_SUPP1;                               \
 446         (b)->bits[2] &= NFSATTRBIT_SUPP2;                               \
 447 } while (0)
 448
 449 #define NFSCLRNOTSETABLE_ATTRBIT(b) do {                                \
 450         (b)->bits[0] &= NFSATTRBIT_SETABLE0;                            \
 451         (b)->bits[1] &= NFSATTRBIT_SETABLE1;                            \
 452         (b)->bits[2] &= NFSATTRBIT_SETABLE2;                            \
 453 } while (0)
 454
 455 #define NFSNONZERO_ATTRBIT(b)   ((b)->bits[0] || (b)->bits[1] || (b)->bits[2])
 456 #define NFSEQUAL_ATTRBIT(b, p)  ((b)->bits[0] == (p)->bits[0] &&        \
 457         (b)->bits[1] == (p)->bits[1] && (b)->bits[2] == (p)->bits[2])
 458
 459 #define NFSGETATTR_ATTRBIT(b) do {                                      \
 460         (b)->bits[0] = NFSATTRBIT_GETATTR0;                             \
 461         (b)->bits[1] = NFSATTRBIT_GETATTR1;                             \
 462         (b)->bits[2] = NFSATTRBIT_GETATTR2;                             \
 463 } while (0)
 464
 465 #define NFSWCCATTR_ATTRBIT(b) do {                                      \
 466         (b)->bits[0] = NFSATTRBIT_WCCATTR0;                             \
 467         (b)->bits[1] = NFSATTRBIT_WCCATTR1;                             \
 468         (b)->bits[2] = NFSATTRBIT_WCCATTR2;                             \
 469 } while (0)
 470
 471 #define NFSWRITEGETATTR_ATTRBIT(b) do {                                 \
 472         (b)->bits[0] = NFSATTRBIT_WRITEGETATTR0;                        \
 473         (b)->bits[1] = NFSATTRBIT_WRITEGETATTR1;                        \
 474         (b)->bits[2] = NFSATTRBIT_WRITEGETATTR2;                        \
 475 } while (0)
 476
 477 #define NFSCBGETATTR_ATTRBIT(b, c) do {                                 \
 478         (c)->bits[0] = ((b)->bits[0] & NFSATTRBIT_CBGETATTR0);          \
 479         (c)->bits[1] = ((b)->bits[1] & NFSATTRBIT_CBGETATTR1);          \
 480         (c)->bits[2] = ((b)->bits[2] & NFSATTRBIT_CBGETATTR2);          \
 481 } while (0)
 482
 483 #define NFSPATHCONF_GETATTRBIT(b) do {                                  \
 484         (b)->bits[0] = NFSGETATTRBIT_PATHCONF0;                         \
 485         (b)->bits[1] = NFSGETATTRBIT_PATHCONF1;                         \
 486         (b)->bits[2] = NFSGETATTRBIT_PATHCONF2;                         \
 487 } while (0)
 488
 489 #define NFSSTATFS_GETATTRBIT(b) do {                                    \
 490         (b)->bits[0] = NFSGETATTRBIT_STATFS0;                           \
 491         (b)->bits[1] = NFSGETATTRBIT_STATFS1;                           \
 492         (b)->bits[2] = NFSGETATTRBIT_STATFS2;                           \
 493 } while (0)
 494
 495 #define NFSISSETSTATFS_ATTRBIT(b)                                       \
 496                 (((b)->bits[0] & NFSATTRBIT_STATFS0) ||                 \
 497                  ((b)->bits[1] & NFSATTRBIT_STATFS1) ||                 \
 498                  ((b)->bits[2] & NFSATTRBIT_STATFS2))
 499
 500 #define NFSCLRSTATFS_ATTRBIT(b) do {                                    \
 501         (b)->bits[0] &= ~NFSATTRBIT_STATFS0;                            \
 502         (b)->bits[1] &= ~NFSATTRBIT_STATFS1;                            \
 503         (b)->bits[2] &= ~NFSATTRBIT_STATFS2;                            \
 504 } while (0)
 505
 506 #define NFSREADDIRPLUS_ATTRBIT(b) do {                                  \
 507         (b)->bits[0] = NFSATTRBIT_READDIRPLUS0;                         \
 508         (b)->bits[1] = NFSATTRBIT_READDIRPLUS1;                         \
 509         (b)->bits[2] = NFSATTRBIT_READDIRPLUS2;                         \
 510 } while (0)
 511
 512 #define NFSREFERRAL_ATTRBIT(b) do {                                     \
 513         (b)->bits[0] = NFSATTRBIT_REFERRAL0;                            \
 514         (b)->bits[1] = NFSATTRBIT_REFERRAL1;                            \
 515         (b)->bits[2] = NFSATTRBIT_REFERRAL2;                            \
 516 } while (0)
 517
 518 /*
 519  * Store uid, gid creds that were used when the stateid was acquired.
 520  * The RPC layer allows NFS_MAXGRPS + 1 groups to go out on the wire,
 521  * so that's how many gets stored here.
 522  */
 523 struct nfscred {
 524         uid_t           nfsc_uid;
 525         gid_t           nfsc_groups[NFS_MAXGRPS + 1];
 526         int             nfsc_ngroups;
 527 };
 528
 529 /*
 530  * Constants that define the file handle for the V4 root directory.
 531  * (The FSID must never be used by other file systems that are exported.)
 532  */
 533 #define NFSV4ROOT_FSID0         ((int32_t) -1)
 534 #define NFSV4ROOT_FSID1         ((int32_t) -1)
 535 #define NFSV4ROOT_REFERRAL      ((int32_t) -2)
 536 #define NFSV4ROOT_INO           2       /* It's traditional */
 537 #define NFSV4ROOT_GEN           1
 538
 539 /*
 540  * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts.
 541  * What should be in this set is open to debate, but I believe that since
 542  * I/O system calls on ufs are never interrupted by signals the set should
 543  * be minimal. My reasoning is that many current programs that use signals
 544  * such as SIGALRM will not expect file I/O system calls to be interrupted
 545  * by them and break.
 546  */
 547 #if defined(_KERNEL) || defined(KERNEL)
 548
 549 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */
 550
 551 /*
 552  * Socket errors ignored for connectionless sockets?
 553  * For now, ignore them all
 554  */
 555 #define NFSIGNORE_SOERROR(s, e)                                         \
 556                 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \
 557                 ((s) & PR_CONNREQUIRED) == 0)
 558
 559
 560 /*
 561  * This structure holds socket information for a connection. Used by the
 562  * client and the server for callbacks.
 563  */
 564 struct nfssockreq {
 565         NFSSOCKADDR_T   nr_nam;
 566         int             nr_sotype;
 567         int             nr_soproto;
 568         int             nr_soflags;
 569         struct ucred    *nr_cred;
 570         int             nr_lock;
 571         NFSMUTEX_T      nr_mtx;
 572         u_int32_t       nr_prog;
 573         u_int32_t       nr_vers;
 574         struct __rpc_client *nr_client;
 575         AUTH            *nr_auth;
 576 };
 577
 578 /*
 579  * And associated nr_lock bits.
 580  */
 581 #define NFSR_SNDLOCK            0x01
 582 #define NFSR_WANTSND            0x02
 583 #define NFSR_RCVLOCK            0x04
 584 #define NFSR_WANTRCV            0x08
 585 #define NFSR_RESERVEDPORT       0x10
 586 #define NFSR_LOCALHOST          0x20
 587
 588 /*
 589  * Queue head for nfsreq's
 590  */
 591 TAILQ_HEAD(nfsreqhead, nfsreq);
 592
 593 /* This is the only nfsreq R_xxx flag still used. */
 594 #define R_DONTRECOVER   0x00000100      /* don't initiate recovery when this
 595                                            rpc gets a stale state reply */
 596
 597 /*
 598  * Network address hash list element
 599  */
 600 union nethostaddr {
 601         struct in_addr  had_inet;
 602         struct in6_addr had_inet6;
 603 };
 604
 605 /*
 606  * Structure of list of mechanisms.
 607  */
 608 struct nfsgss_mechlist {
 609         int     len;
 610         const u_char    *str;
 611         int     totlen;
 612 };
 613 #define KERBV_MECH      0       /* position in list */
 614
 615 /*
 616  * This structure is used by the server for describing each request.
 617  */
 618 struct nfsrv_descript {
 619         mbuf_t                  nd_mrep;        /* Request mbuf list */
 620         mbuf_t                  nd_md;          /* Current dissect mbuf */
 621         mbuf_t                  nd_mreq;        /* Reply mbuf list */
 622         mbuf_t                  nd_mb;          /* Current build mbuf */
 623         NFSSOCKADDR_T           nd_nam;         /* and socket addr */
 624         NFSSOCKADDR_T           nd_nam2;        /* return socket addr */
 625         caddr_t                 nd_dpos;        /* Current dissect pos */
 626         caddr_t                 nd_bpos;        /* Current build pos */
 627         u_int64_t               nd_flag;        /* nd_flag */
 628         u_int16_t               nd_procnum;     /* RPC # */
 629         u_int32_t               nd_repstat;     /* Reply status */
 630         int                     *nd_errp;       /* Pointer to ret status */
 631         u_int32_t               nd_retxid;      /* Reply xid */
 632         struct nfsrvcache       *nd_rp;         /* Assoc. cache entry */
 633         fhandle_t               nd_fh;          /* File handle */
 634         struct ucred            *nd_cred;       /* Credentials */
 635         uid_t                   nd_saveduid;    /* Saved uid */
 636         u_int64_t               nd_sockref;     /* Rcv socket ref# */
 637         u_int64_t               nd_compref;     /* Compound RPC ref# */
 638         time_t                  nd_tcpconntime; /* Time TCP connection est. */
 639         nfsquad_t               nd_clientid;    /* Implied clientid */
 640         int                     nd_gssnamelen;  /* principal name length */
 641         char                    *nd_gssname;    /* principal name */
 642         uint32_t                *nd_slotseq;    /* ptr to slot seq# in req */
 643         uint8_t                 nd_sessionid[NFSX_V4SESSIONID]; /* Session id */
 644         uint32_t                nd_slotid;      /* Slotid for this RPC */
 645         SVCXPRT                 *nd_xprt;       /* Server RPC handle */
 646         uint32_t                *nd_sequence;   /* Sequence Op. ptr */
 647         nfsv4stateid_t          nd_curstateid;  /* Current StateID */
 648         nfsv4stateid_t          nd_savedcurstateid; /* Saved Current StateID */
 649 };
 650
 651 #define nd_princlen     nd_gssnamelen
 652 #define nd_principal    nd_gssname
 653
 654 /* Bits for "nd_flag" */
 655 #define ND_DONTSAVEREPLY        0x00000001
 656 #define ND_SAVEREPLY            0x00000002
 657 #define ND_NFSV2                0x00000004
 658 #define ND_NFSV3                0x00000008
 659 #define ND_NFSV4                0x00000010
 660 #define ND_KERBV                0x00000020
 661 #define ND_GSSINTEGRITY         0x00000040
 662 #define ND_GSSPRIVACY           0x00000080
 663 #define ND_WINDOWVERF           0x00000100
 664 #define ND_GSSINITREPLY         0x00000200
 665 #define ND_STREAMSOCK           0x00000400
 666 #define ND_PUBLOOKUP            0x00000800
 667 #define ND_USEGSSNAME           0x00001000
 668 #define ND_SAMETCPCONN          0x00002000
 669 #define ND_IMPLIEDCLID          0x00004000
 670 #define ND_NOMOREDATA           0x00008000
 671 #define ND_V4WCCATTR            0x00010000
 672 #define ND_NFSCB                0x00020000
 673 #define ND_AUTHNONE             0x00040000
 674 #define ND_EXAUTHSYS            0x00080000
 675 #define ND_EXGSS                0x00100000
 676 #define ND_EXGSSINTEGRITY       0x00200000
 677 #define ND_EXGSSPRIVACY         0x00400000
 678 #define ND_INCRSEQID            0x00800000
 679 #define ND_NFSCL                0x01000000
 680 #define ND_NFSV41               0x02000000
 681 #define ND_HASSEQUENCE          0x04000000
 682 #define ND_CACHETHIS            0x08000000
 683 #define ND_LASTOP               0x10000000
 684 #define ND_LOOPBADSESS          0x20000000
 685 #define ND_DSSERVER             0x40000000
 686 #define ND_CURSTATEID           0x80000000
 687 #define ND_SAVEDCURSTATEID      0x100000000
 688 #define ND_HASSLOTID            0x200000000
 689
 690 /*
 691  * ND_GSS should be the "or" of all GSS type authentications.
 692  */
 693 #define ND_GSS          (ND_KERBV)
 694
 695 struct nfsv4_opflag {
 696         int     retfh;
 697         int     needscfh;
 698         int     savereply;
 699         int     modifyfs;
 700         int     lktype;
 701         int     needsseq;
 702         int     loopbadsess;
 703 };
 704
 705 /*
 706  * Flags used to indicate what to do w.r.t. seqid checking.
 707  */
 708 #define NFSRVSEQID_FIRST        0x01
 709 #define NFSRVSEQID_LAST         0x02
 710 #define NFSRVSEQID_OPEN         0x04
 711
 712 /*
 713  * assign a doubly linked list to a new head
 714  * and prepend one list into another.
 715  */
 716 #define LIST_NEWHEAD(nhead, ohead, field) do {                          \
 717         if (((nhead)->lh_first = (ohead)->lh_first) != NULL)            \
 718                 (ohead)->lh_first->field.le_prev = &(nhead)->lh_first;  \
 719         (ohead)->lh_first = NULL;                                       \
 720     } while (0)
 721
 722 #define LIST_PREPEND(head, phead, lelm, field) do {                     \
 723         if ((head)->lh_first != NULL) {                                 \
 724                 (lelm)->field.le_next = (head)->lh_first;               \
 725                 (lelm)->field.le_next->field.le_prev =                  \
 726                     &(lelm)->field.le_next;                             \
 727         }                                                               \
 728         (head)->lh_first = (phead)->lh_first;                           \
 729         (head)->lh_first->field.le_prev = &(head)->lh_first;            \
 730     } while (0)
 731
 732 /*
 733  * File handle structure for client. Malloc'd to the correct length with
 734  * malloc type M_NFSFH.
 735  */
 736 struct nfsfh {
 737         u_int16_t       nfh_len;        /* Length of file handle */
 738         u_int8_t        nfh_fh[1];      /* and the file handle */
 739 };
 740
 741 /*
 742  * File handle structure for server. The NFSRV_MAXFH constant is
 743  * set in nfsdport.h. I use a 32bit length, so that alignment is
 744  * preserved.
 745  */
 746 struct nfsrvfh {
 747         u_int32_t       nfsrvfh_len;
 748         u_int8_t        nfsrvfh_data[NFSRV_MAXFH];
 749 };
 750
 751 /*
 752  * This structure is used for sleep locks on the NFSv4 nfsd threads and
 753  * NFSv4 client data structures.
 754  */
 755 struct nfsv4lock {
 756         u_int32_t       nfslock_usecnt;
 757         u_int8_t        nfslock_lock;
 758 };
 759 #define NFSV4LOCK_LOCK          0x01
 760 #define NFSV4LOCK_LOCKWANTED    0x02
 761 #define NFSV4LOCK_WANTED        0x04
 762
 763 /*
 764  * Values for the override argument for nfsvno_accchk().
 765  */
 766 #define NFSACCCHK_NOOVERRIDE            0
 767 #define NFSACCCHK_ALLOWROOT             1
 768 #define NFSACCCHK_ALLOWOWNER            2
 769
 770 /*
 771  * and values for the vpislocked argument for nfsvno_accchk().
 772  */
 773 #define NFSACCCHK_VPNOTLOCKED           0
 774 #define NFSACCCHK_VPISLOCKED            1
 775
 776 /*
 777  * Slot for the NFSv4.1 Sequence Op.
 778  */
 779 struct nfsslot {
 780         int             nfssl_inprog;
 781         uint32_t        nfssl_seq;
 782         struct mbuf     *nfssl_reply;
 783 };
 784
 785 #endif  /* _KERNEL */
 786
 787 #endif  /* _NFS_NFS_H */