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