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 */ 203 #define NFSDEV_MAXMIRRORS 4 204 #define NFSDEV_MAXVERS 4 205 206 struct nfsd_pnfsd_args { 207 int op; /* Which pNFSd op to perform. */ 208 char *mdspath; /* Path of MDS file. */ 209 char *dspath; /* Path of recovered DS mounted on dir. */ 210 char *curdspath; /* Path of current DS mounted on dir. */ 211 }; 212 213 #define PNFSDOP_DELDSSERVER 1 214 #define PNFSDOP_COPYMR 2 215 #define PNFSDOP_FORCEDELDS 3 216 217 /* Old version. */ 218 struct nfsd_nfsd_oargs { 219 const char *principal; /* GSS-API service principal name */ 220 int minthreads; /* minimum service thread count */ 221 int maxthreads; /* maximum service thread count */ 222 }; 223 224 /* 225 * Arguments for use by the callback daemon. 226 */ 227 struct nfsd_nfscbd_args { 228 const char *principal; /* GSS-API service principal name */ 229 }; 230 231 struct nfscbd_args { 232 int sock; /* Socket to serve */ 233 caddr_t name; /* Client addr for connection based sockets */ 234 int namelen; /* Length of name */ 235 u_short port; /* Port# for callbacks */ 236 }; 237 238 struct nfsd_oidargs { 239 int nid_flag; /* Flags (see below) */ 240 uid_t nid_uid; /* user/group id */ 241 gid_t nid_gid; 242 int nid_usermax; /* Upper bound on user name cache */ 243 int nid_usertimeout;/* User name timeout (minutes) */ 244 u_char *nid_name; /* Name */ 245 int nid_namelen; /* and its length */ 246 }; 247 248 struct nfsuserd_args { 249 sa_family_t nuserd_family; /* Address family to use */ 250 u_short nuserd_port; /* Port# */ 251 }; 252 253 struct nfsd_clid { 254 int nclid_idlen; /* Length of client id */ 255 u_char nclid_id[NFSV4_OPAQUELIMIT]; /* and name */ 256 }; 257 258 struct nfsd_dumplist { 259 int ndl_size; /* Number of elements */ 260 void *ndl_list; /* and the list of elements */ 261 }; 262 263 struct nfsd_dumpclients { 264 u_int32_t ndcl_flags; /* LCL_xxx flags */ 265 u_int32_t ndcl_nopenowners; /* Number of openowners */ 266 u_int32_t ndcl_nopens; /* and opens */ 267 u_int32_t ndcl_nlockowners; /* and of lockowners */ 268 u_int32_t ndcl_nlocks; /* and of locks */ 269 u_int32_t ndcl_ndelegs; /* and of delegations */ 270 u_int32_t ndcl_nolddelegs; /* and old delegations */ 271 sa_family_t ndcl_addrfam; /* Callback address */ 272 union { 273 struct in_addr sin_addr; 274 struct in6_addr sin6_addr; 275 } ndcl_cbaddr; 276 struct nfsd_clid ndcl_clid; /* and client id */ 277 }; 278 279 struct nfsd_dumplocklist { 280 char *ndllck_fname; /* File Name */ 281 int ndllck_size; /* Number of elements */ 282 void *ndllck_list; /* and the list of elements */ 283 }; 284 285 struct nfsd_dumplocks { 286 u_int32_t ndlck_flags; /* state flags NFSLCK_xxx */ 287 nfsv4stateid_t ndlck_stateid; /* stateid */ 288 u_int64_t ndlck_first; /* lock byte range */ 289 u_int64_t ndlck_end; 290 struct nfsd_clid ndlck_owner; /* Owner of open/lock */ 291 sa_family_t ndlck_addrfam; /* Callback address */ 292 union { 293 struct in_addr sin_addr; 294 struct in6_addr sin6_addr; 295 } ndlck_cbaddr; 296 struct nfsd_clid ndlck_clid; /* and client id */ 297 }; 298 299 /* 300 * Structure for referral information. 301 */ 302 struct nfsreferral { 303 u_char *nfr_srvlist; /* List of servers */ 304 int nfr_srvcnt; /* number of servers */ 305 vnode_t nfr_vp; /* vnode for referral */ 306 uint64_t nfr_dfileno; /* assigned dir inode# */ 307 }; 308 309 /* 310 * Flags for lc_flags and opsflags for nfsrv_getclient(). 311 */ 312 #define LCL_NEEDSCONFIRM 0x00000001 313 #define LCL_DONTCLEAN 0x00000002 314 #define LCL_WAKEUPWANTED 0x00000004 315 #define LCL_TCPCALLBACK 0x00000008 316 #define LCL_CALLBACKSON 0x00000010 317 #define LCL_INDEXNOTOK 0x00000020 318 #define LCL_STAMPEDSTABLE 0x00000040 319 #define LCL_EXPIREIT 0x00000080 320 #define LCL_CBDOWN 0x00000100 321 #define LCL_KERBV 0x00000400 322 #define LCL_NAME 0x00000800 323 #define LCL_NEEDSCBNULL 0x00001000 324 #define LCL_GSSINTEGRITY 0x00002000 325 #define LCL_GSSPRIVACY 0x00004000 326 #define LCL_ADMINREVOKED 0x00008000 327 #define LCL_RECLAIMCOMPLETE 0x00010000 328 #define LCL_NFSV41 0x00020000 329 #define LCL_DONEBINDCONN 0x00040000 330 #define LCL_RECLAIMONEFS 0x00080000 331 #define LCL_NFSV42 0x00100000 332 #define LCL_TLSCB 0x00200000 333 #define LCL_MACHCRED 0x00400000 334 335 #define LCL_GSS LCL_KERBV /* Or of all mechs */ 336 337 /* 338 * Bits for flags in nfslock and nfsstate. 339 * The access, deny, NFSLCK_READ and NFSLCK_WRITE bits must be defined as 340 * below, in the correct order, so the shifts work for tests. 341 */ 342 #define NFSLCK_READACCESS 0x00000001 343 #define NFSLCK_WRITEACCESS 0x00000002 344 #define NFSLCK_ACCESSBITS (NFSLCK_READACCESS | NFSLCK_WRITEACCESS) 345 #define NFSLCK_SHIFT 2 346 #define NFSLCK_READDENY 0x00000004 347 #define NFSLCK_WRITEDENY 0x00000008 348 #define NFSLCK_DENYBITS (NFSLCK_READDENY | NFSLCK_WRITEDENY) 349 #define NFSLCK_SHAREBITS \ 350 (NFSLCK_READACCESS|NFSLCK_WRITEACCESS|NFSLCK_READDENY|NFSLCK_WRITEDENY) 351 #define NFSLCK_LOCKSHIFT 4 352 #define NFSLCK_READ 0x00000010 353 #define NFSLCK_WRITE 0x00000020 354 #define NFSLCK_BLOCKING 0x00000040 355 #define NFSLCK_RECLAIM 0x00000080 356 #define NFSLCK_OPENTOLOCK 0x00000100 357 #define NFSLCK_TEST 0x00000200 358 #define NFSLCK_LOCK 0x00000400 359 #define NFSLCK_UNLOCK 0x00000800 360 #define NFSLCK_OPEN 0x00001000 361 #define NFSLCK_CLOSE 0x00002000 362 #define NFSLCK_CHECK 0x00004000 363 #define NFSLCK_RELEASE 0x00008000 364 #define NFSLCK_NEEDSCONFIRM 0x00010000 365 #define NFSLCK_CONFIRM 0x00020000 366 #define NFSLCK_DOWNGRADE 0x00040000 367 #define NFSLCK_DELEGREAD 0x00080000 368 #define NFSLCK_DELEGWRITE 0x00100000 369 #define NFSLCK_DELEGCUR 0x00200000 370 #define NFSLCK_DELEGPREV 0x00400000 371 #define NFSLCK_OLDDELEG 0x00800000 372 #define NFSLCK_DELEGRECALL 0x01000000 373 #define NFSLCK_SETATTR 0x02000000 374 #define NFSLCK_DELEGPURGE 0x04000000 375 #define NFSLCK_DELEGRETURN 0x08000000 376 #define NFSLCK_WANTWDELEG 0x10000000 377 #define NFSLCK_WANTRDELEG 0x20000000 378 #define NFSLCK_WANTNODELEG 0x40000000 379 #define NFSLCK_WANTBITS \ 380 (NFSLCK_WANTWDELEG | NFSLCK_WANTRDELEG | NFSLCK_WANTNODELEG) 381 382 /* 383 * fs.nfs sysctl(3) identifiers 384 */ 385 #define NFS_NFSSTATS 1 /* struct: struct nfsstats */ 386 387 /* 388 * Here is the definition of the attribute bits array and macros that 389 * manipulate it. 390 * THE MACROS MUST BE MANUALLY MODIFIED IF NFSATTRBIT_MAXWORDS CHANGES!! 391 * It is (NFSATTRBIT_MAX + 31) / 32. 392 */ 393 #define NFSATTRBIT_MAXWORDS 3 394 395 typedef struct { 396 u_int32_t bits[NFSATTRBIT_MAXWORDS]; 397 } nfsattrbit_t; 398 399 #define NFSZERO_ATTRBIT(b) do { \ 400 (b)->bits[0] = 0; \ 401 (b)->bits[1] = 0; \ 402 (b)->bits[2] = 0; \ 403 } while (0) 404 405 #define NFSSET_ATTRBIT(t, f) do { \ 406 (t)->bits[0] = (f)->bits[0]; \ 407 (t)->bits[1] = (f)->bits[1]; \ 408 (t)->bits[2] = (f)->bits[2]; \ 409 } while (0) 410 411 #define NFSSETSUPP_ATTRBIT(b, n) do { \ 412 (b)->bits[0] = NFSATTRBIT_SUPP0; \ 413 (b)->bits[1] = (NFSATTRBIT_SUPP1 | NFSATTRBIT_SUPPSETONLY1); \ 414 (b)->bits[2] = (NFSATTRBIT_SUPP2 | NFSATTRBIT_SUPPSETONLY2); \ 415 if (((n)->nd_flag & ND_NFSV41) == 0) { \ 416 (b)->bits[1] &= ~NFSATTRBIT_NFSV41_1; \ 417 (b)->bits[2] &= ~NFSATTRBIT_NFSV41_2; \ 418 } \ 419 if (((n)->nd_flag & ND_NFSV42) == 0) \ 420 (b)->bits[2] &= ~NFSATTRBIT_NFSV42_2; \ 421 } while (0) 422 423 #define NFSISSET_ATTRBIT(b, p) ((b)->bits[(p) / 32] & (1 << ((p) % 32))) 424 #define NFSSETBIT_ATTRBIT(b, p) ((b)->bits[(p) / 32] |= (1 << ((p) % 32))) 425 #define NFSCLRBIT_ATTRBIT(b, p) ((b)->bits[(p) / 32] &= ~(1 << ((p) % 32))) 426 427 #define NFSCLRALL_ATTRBIT(b, a) do { \ 428 (b)->bits[0] &= ~((a)->bits[0]); \ 429 (b)->bits[1] &= ~((a)->bits[1]); \ 430 (b)->bits[2] &= ~((a)->bits[2]); \ 431 } while (0) 432 433 #define NFSCLRNOT_ATTRBIT(b, a) do { \ 434 (b)->bits[0] &= ((a)->bits[0]); \ 435 (b)->bits[1] &= ((a)->bits[1]); \ 436 (b)->bits[2] &= ((a)->bits[2]); \ 437 } while (0) 438 439 #define NFSCLRNOTFILLABLE_ATTRBIT(b, n) do { \ 440 (b)->bits[0] &= NFSATTRBIT_SUPP0; \ 441 (b)->bits[1] &= NFSATTRBIT_SUPP1; \ 442 (b)->bits[2] &= NFSATTRBIT_SUPP2; \ 443 if (((n)->nd_flag & ND_NFSV41) == 0) { \ 444 (b)->bits[1] &= ~NFSATTRBIT_NFSV41_1; \ 445 (b)->bits[2] &= ~NFSATTRBIT_NFSV41_2; \ 446 } \ 447 if (((n)->nd_flag & ND_NFSV42) == 0) \ 448 (b)->bits[2] &= ~NFSATTRBIT_NFSV42_2; \ 449 } while (0) 450 451 #define NFSCLRNOTSETABLE_ATTRBIT(b, n) do { \ 452 (b)->bits[0] &= NFSATTRBIT_SETABLE0; \ 453 (b)->bits[1] &= NFSATTRBIT_SETABLE1; \ 454 (b)->bits[2] &= NFSATTRBIT_SETABLE2; \ 455 if (((n)->nd_flag & ND_NFSV41) == 0) \ 456 (b)->bits[2] &= ~NFSATTRBIT_NFSV41_2; \ 457 if (((n)->nd_flag & ND_NFSV42) == 0) \ 458 (b)->bits[2] &= ~NFSATTRBIT_NFSV42_2; \ 459 } while (0) 460 461 #define NFSNONZERO_ATTRBIT(b) ((b)->bits[0] || (b)->bits[1] || (b)->bits[2]) 462 #define NFSEQUAL_ATTRBIT(b, p) ((b)->bits[0] == (p)->bits[0] && \ 463 (b)->bits[1] == (p)->bits[1] && (b)->bits[2] == (p)->bits[2]) 464 465 #define NFSGETATTR_ATTRBIT(b) do { \ 466 (b)->bits[0] = NFSATTRBIT_GETATTR0; \ 467 (b)->bits[1] = NFSATTRBIT_GETATTR1; \ 468 (b)->bits[2] = NFSATTRBIT_GETATTR2; \ 469 } while (0) 470 471 #define NFSWCCATTR_ATTRBIT(b) do { \ 472 (b)->bits[0] = NFSATTRBIT_WCCATTR0; \ 473 (b)->bits[1] = NFSATTRBIT_WCCATTR1; \ 474 (b)->bits[2] = NFSATTRBIT_WCCATTR2; \ 475 } while (0) 476 477 #define NFSWRITEGETATTR_ATTRBIT(b) do { \ 478 (b)->bits[0] = NFSATTRBIT_WRITEGETATTR0; \ 479 (b)->bits[1] = NFSATTRBIT_WRITEGETATTR1; \ 480 (b)->bits[2] = NFSATTRBIT_WRITEGETATTR2; \ 481 } while (0) 482 483 #define NFSCBGETATTR_ATTRBIT(b, c) do { \ 484 (c)->bits[0] = ((b)->bits[0] & NFSATTRBIT_CBGETATTR0); \ 485 (c)->bits[1] = ((b)->bits[1] & NFSATTRBIT_CBGETATTR1); \ 486 (c)->bits[2] = ((b)->bits[2] & NFSATTRBIT_CBGETATTR2); \ 487 } while (0) 488 489 #define NFSPATHCONF_GETATTRBIT(b) do { \ 490 (b)->bits[0] = NFSGETATTRBIT_PATHCONF0; \ 491 (b)->bits[1] = NFSGETATTRBIT_PATHCONF1; \ 492 (b)->bits[2] = NFSGETATTRBIT_PATHCONF2; \ 493 } while (0) 494 495 #define NFSSTATFS_GETATTRBIT(b) do { \ 496 (b)->bits[0] = NFSGETATTRBIT_STATFS0; \ 497 (b)->bits[1] = NFSGETATTRBIT_STATFS1; \ 498 (b)->bits[2] = NFSGETATTRBIT_STATFS2; \ 499 } while (0) 500 501 #define NFSROOTFS_GETATTRBIT(b) do { \ 502 (b)->bits[0] = NFSGETATTRBIT_STATFS0 | NFSATTRBIT_GETATTR0 | \ 503 NFSATTRBM_LEASETIME; \ 504 (b)->bits[1] = NFSGETATTRBIT_STATFS1 | NFSATTRBIT_GETATTR1; \ 505 (b)->bits[2] = NFSGETATTRBIT_STATFS2 | NFSATTRBIT_GETATTR2; \ 506 } while (0) 507 508 #define NFSISSETSTATFS_ATTRBIT(b) \ 509 (((b)->bits[0] & NFSATTRBIT_STATFS0) || \ 510 ((b)->bits[1] & NFSATTRBIT_STATFS1) || \ 511 ((b)->bits[2] & NFSATTRBIT_STATFS2)) 512 513 #define NFSCLRSTATFS_ATTRBIT(b) do { \ 514 (b)->bits[0] &= ~NFSATTRBIT_STATFS0; \ 515 (b)->bits[1] &= ~NFSATTRBIT_STATFS1; \ 516 (b)->bits[2] &= ~NFSATTRBIT_STATFS2; \ 517 } while (0) 518 519 #define NFSREADDIRPLUS_ATTRBIT(b) do { \ 520 (b)->bits[0] = NFSATTRBIT_READDIRPLUS0; \ 521 (b)->bits[1] = NFSATTRBIT_READDIRPLUS1; \ 522 (b)->bits[2] = NFSATTRBIT_READDIRPLUS2; \ 523 } while (0) 524 525 #define NFSREFERRAL_ATTRBIT(b) do { \ 526 (b)->bits[0] = NFSATTRBIT_REFERRAL0; \ 527 (b)->bits[1] = NFSATTRBIT_REFERRAL1; \ 528 (b)->bits[2] = NFSATTRBIT_REFERRAL2; \ 529 } while (0) 530 531 /* 532 * Here is the definition of the operation bits array and macros that 533 * manipulate it. 534 * THE MACROS MUST BE MANUALLY MODIFIED IF NFSOPBIT_MAXWORDS CHANGES!! 535 * It is (NFSV42_NOPS + 31) / 32. 536 */ 537 #define NFSOPBIT_MAXWORDS 3 538 539 typedef struct { 540 uint32_t bits[NFSOPBIT_MAXWORDS]; 541 } nfsopbit_t; 542 543 #define NFSZERO_OPBIT(b) do { \ 544 (b)->bits[0] = 0; \ 545 (b)->bits[1] = 0; \ 546 (b)->bits[2] = 0; \ 547 } while (0) 548 549 #define NFSSET_OPBIT(t, f) do { \ 550 (t)->bits[0] = (f)->bits[0]; \ 551 (t)->bits[1] = (f)->bits[1]; \ 552 (t)->bits[2] = (f)->bits[2]; \ 553 } while (0) 554 555 #define NFSISSET_OPBIT(b, p) ((b)->bits[(p) / 32] & (1 << ((p) % 32))) 556 #define NFSSETBIT_OPBIT(b, p) ((b)->bits[(p) / 32] |= (1 << ((p) % 32))) 557 #define NFSCLRBIT_OPBIT(b, p) ((b)->bits[(p) / 32] &= ~(1 << ((p) % 32))) 558 559 /* 560 * Store uid, gid creds that were used when the stateid was acquired. 561 * The RPC layer allows NFS_MAXGRPS + 1 groups to go out on the wire, 562 * so that's how many gets stored here. 563 */ 564 struct nfscred { 565 uid_t nfsc_uid; 566 gid_t nfsc_groups[NFS_MAXGRPS + 1]; 567 int nfsc_ngroups; 568 }; 569 570 /* 571 * Constants that define the file handle for the V4 root directory. 572 * (The FSID must never be used by other file systems that are exported.) 573 */ 574 #define NFSV4ROOT_FSID0 ((int32_t) -1) 575 #define NFSV4ROOT_FSID1 ((int32_t) -1) 576 #define NFSV4ROOT_REFERRAL ((int32_t) -2) 577 #define NFSV4ROOT_INO 2 /* It's traditional */ 578 #define NFSV4ROOT_GEN 1 579 580 /* 581 * The set of signals the interrupt an I/O in progress for NFSMNT_INT mounts. 582 * What should be in this set is open to debate, but I believe that since 583 * I/O system calls on ufs are never interrupted by signals the set should 584 * be minimal. My reasoning is that many current programs that use signals 585 * such as SIGALRM will not expect file I/O system calls to be interrupted 586 * by them and break. 587 */ 588 #if defined(_KERNEL) || defined(KERNEL) 589 590 struct uio; struct buf; struct vattr; struct nameidata; /* XXX */ 591 592 /* 593 * Socket errors ignored for connectionless sockets? 594 * For now, ignore them all 595 */ 596 #define NFSIGNORE_SOERROR(s, e) \ 597 ((e) != EINTR && (e) != ERESTART && (e) != EWOULDBLOCK && \ 598 ((s) & PR_CONNREQUIRED) == 0) 599 600 /* 601 * This structure holds socket information for a connection. Used by the 602 * client and the server for callbacks. 603 */ 604 struct nfssockreq { 605 NFSSOCKADDR_T nr_nam; 606 int nr_sotype; 607 int nr_soproto; 608 int nr_soflags; 609 struct ucred *nr_cred; 610 int nr_lock; 611 NFSMUTEX_T nr_mtx; 612 u_int32_t nr_prog; 613 u_int32_t nr_vers; 614 struct __rpc_client *nr_client; 615 AUTH *nr_auth; 616 char nr_srvprinc[1]; 617 }; 618 619 /* 620 * And associated nr_lock bits. 621 */ 622 #define NFSR_SNDLOCK 0x01 623 #define NFSR_WANTSND 0x02 624 #define NFSR_RCVLOCK 0x04 625 #define NFSR_WANTRCV 0x08 626 #define NFSR_RESERVEDPORT 0x10 627 #define NFSR_LOCALHOST 0x20 628 629 /* 630 * Queue head for nfsreq's 631 */ 632 TAILQ_HEAD(nfsreqhead, nfsreq); 633 634 /* This is the only nfsreq R_xxx flag still used. */ 635 #define R_DONTRECOVER 0x00000100 /* don't initiate recovery when this 636 rpc gets a stale state reply */ 637 638 /* 639 * Network address hash list element 640 */ 641 union nethostaddr { 642 struct in_addr had_inet; 643 struct in6_addr had_inet6; 644 }; 645 646 /* 647 * Structure of list of mechanisms. 648 */ 649 struct nfsgss_mechlist { 650 int len; 651 const u_char *str; 652 int totlen; 653 }; 654 #define KERBV_MECH 0 /* position in list */ 655 656 /* 657 * This structure is used by the server for describing each request. 658 */ 659 struct nfsrv_descript { 660 struct mbuf *nd_mrep; /* Request mbuf list */ 661 struct mbuf *nd_md; /* Current dissect mbuf */ 662 struct mbuf *nd_mreq; /* Reply mbuf list */ 663 struct mbuf *nd_mb; /* Current build mbuf */ 664 NFSSOCKADDR_T nd_nam; /* and socket addr */ 665 NFSSOCKADDR_T nd_nam2; /* return socket addr */ 666 caddr_t nd_dpos; /* Current dissect pos */ 667 caddr_t nd_bpos; /* Current build pos */ 668 u_int64_t nd_flag; /* nd_flag */ 669 u_int16_t nd_procnum; /* RPC # */ 670 u_int32_t nd_repstat; /* Reply status */ 671 int *nd_errp; /* Pointer to ret status */ 672 u_int32_t nd_retxid; /* Reply xid */ 673 struct nfsrvcache *nd_rp; /* Assoc. cache entry */ 674 fhandle_t nd_fh; /* File handle */ 675 struct ucred *nd_cred; /* Credentials */ 676 uid_t nd_saveduid; /* Saved uid */ 677 u_int64_t nd_sockref; /* Rcv socket ref# */ 678 u_int64_t nd_compref; /* Compound RPC ref# */ 679 time_t nd_tcpconntime; /* Time TCP connection est. */ 680 nfsquad_t nd_clientid; /* Implied clientid */ 681 int nd_gssnamelen; /* principal name length */ 682 char *nd_gssname; /* principal name */ 683 uint32_t *nd_slotseq; /* ptr to slot seq# in req */ 684 uint8_t nd_sessionid[NFSX_V4SESSIONID]; /* Session id */ 685 uint32_t nd_slotid; /* Slotid for this RPC */ 686 SVCXPRT *nd_xprt; /* Server RPC handle */ 687 uint32_t *nd_sequence; /* Sequence Op. ptr */ 688 nfsv4stateid_t nd_curstateid; /* Current StateID */ 689 nfsv4stateid_t nd_savedcurstateid; /* Saved Current StateID */ 690 uint32_t nd_maxreq; /* Max. request (session). */ 691 uint32_t nd_maxresp; /* Max. reply (session). */ 692 int nd_bextpg; /* Current ext_pgs page */ 693 int nd_bextpgsiz; /* Bytes left in page */ 694 int nd_maxextsiz; /* Max ext_pgs mbuf size */ 695 nfsopbit_t nd_allowops; /* Allowed ops ND_MACHCRED */ 696 }; 697 698 #define nd_princlen nd_gssnamelen 699 #define nd_principal nd_gssname 700 701 /* Bits for "nd_flag" */ 702 #define ND_DONTSAVEREPLY 0x00000001 703 #define ND_SAVEREPLY 0x00000002 704 #define ND_NFSV2 0x00000004 705 #define ND_NFSV3 0x00000008 706 #define ND_NFSV4 0x00000010 707 #define ND_KERBV 0x00000020 708 #define ND_GSSINTEGRITY 0x00000040 709 #define ND_GSSPRIVACY 0x00000080 710 #define ND_WINDOWVERF 0x00000100 711 #define ND_GSSINITREPLY 0x00000200 712 #define ND_STREAMSOCK 0x00000400 713 #define ND_PUBLOOKUP 0x00000800 714 #define ND_USEGSSNAME 0x00001000 715 #define ND_SAMETCPCONN 0x00002000 716 #define ND_IMPLIEDCLID 0x00004000 717 #define ND_NOMOREDATA 0x00008000 718 #define ND_V4WCCATTR 0x00010000 719 #define ND_NFSCB 0x00020000 720 #define ND_AUTHNONE 0x00040000 721 #define ND_EXAUTHSYS 0x00080000 722 #define ND_EXGSS 0x00100000 723 #define ND_EXGSSINTEGRITY 0x00200000 724 #define ND_EXGSSPRIVACY 0x00400000 725 #define ND_INCRSEQID 0x00800000 726 #define ND_NFSCL 0x01000000 727 #define ND_NFSV41 0x02000000 728 #define ND_HASSEQUENCE 0x04000000 729 #define ND_CACHETHIS 0x08000000 730 #define ND_LASTOP 0x10000000 731 #define ND_LOOPBADSESS 0x20000000 732 #define ND_DSSERVER 0x40000000 733 #define ND_CURSTATEID 0x80000000 734 #define ND_SAVEDCURSTATEID 0x100000000 735 #define ND_HASSLOTID 0x200000000 736 #define ND_NFSV42 0x400000000 737 #define ND_EXTPG 0x800000000 738 #define ND_TLS 0x1000000000 739 #define ND_TLSCERT 0x2000000000 740 #define ND_TLSCERTUSER 0x4000000000 741 #define ND_EXTLS 0x8000000000 742 #define ND_EXTLSCERT 0x10000000000 743 #define ND_EXTLSCERTUSER 0x20000000000 744 #define ND_ERELOOKUP 0x40000000000 745 #define ND_MACHCRED 0x80000000000 746 747 /* 748 * ND_GSS should be the "or" of all GSS type authentications. 749 */ 750 #define ND_GSS (ND_KERBV) 751 752 struct nfsv4_opflag { 753 int retfh; 754 int needscfh; 755 int savereply; 756 int modifyfs; 757 int lktype; 758 int needsseq; 759 int loopbadsess; 760 }; 761 762 /* 763 * Flags used to indicate what to do w.r.t. seqid checking. 764 */ 765 #define NFSRVSEQID_FIRST 0x01 766 #define NFSRVSEQID_LAST 0x02 767 #define NFSRVSEQID_OPEN 0x04 768 769 /* 770 * assign a doubly linked list to a new head 771 * and prepend one list into another. 772 */ 773 #define LIST_NEWHEAD(nhead, ohead, field) do { \ 774 if (((nhead)->lh_first = (ohead)->lh_first) != NULL) \ 775 (ohead)->lh_first->field.le_prev = &(nhead)->lh_first; \ 776 (ohead)->lh_first = NULL; \ 777 } while (0) 778 779 #define LIST_PREPEND(head, phead, lelm, field) do { \ 780 if ((head)->lh_first != NULL) { \ 781 (lelm)->field.le_next = (head)->lh_first; \ 782 (lelm)->field.le_next->field.le_prev = \ 783 &(lelm)->field.le_next; \ 784 } \ 785 (head)->lh_first = (phead)->lh_first; \ 786 (head)->lh_first->field.le_prev = &(head)->lh_first; \ 787 } while (0) 788 789 /* 790 * File handle structure for client. Malloc'd to the correct length with 791 * malloc type M_NFSFH. 792 */ 793 struct nfsfh { 794 u_int16_t nfh_len; /* Length of file handle */ 795 u_int8_t nfh_fh[1]; /* and the file handle */ 796 }; 797 798 /* 799 * File handle structure for server. The NFSRV_MAXFH constant is 800 * set in nfsdport.h. I use a 32bit length, so that alignment is 801 * preserved. 802 */ 803 struct nfsrvfh { 804 u_int32_t nfsrvfh_len; 805 u_int8_t nfsrvfh_data[NFSRV_MAXFH]; 806 }; 807 808 /* 809 * This structure is used for sleep locks on the NFSv4 nfsd threads and 810 * NFSv4 client data structures. 811 */ 812 struct nfsv4lock { 813 u_int32_t nfslock_usecnt; 814 u_int8_t nfslock_lock; 815 }; 816 #define NFSV4LOCK_LOCK 0x01 817 #define NFSV4LOCK_LOCKWANTED 0x02 818 #define NFSV4LOCK_WANTED 0x04 819 820 /* 821 * Values for the override argument for nfsvno_accchk(). 822 */ 823 #define NFSACCCHK_NOOVERRIDE 0 824 #define NFSACCCHK_ALLOWROOT 1 825 #define NFSACCCHK_ALLOWOWNER 2 826 827 /* 828 * and values for the vpislocked argument for nfsvno_accchk(). 829 */ 830 #define NFSACCCHK_VPNOTLOCKED 0 831 #define NFSACCCHK_VPISLOCKED 1 832 833 /* 834 * Slot for the NFSv4.1 Sequence Op. 835 */ 836 struct nfsslot { 837 int nfssl_inprog; 838 uint32_t nfssl_seq; 839 struct mbuf *nfssl_reply; 840 }; 841 842 /* Enumerated type for nfsuserd state. */ 843 typedef enum { NOTRUNNING=0, STARTSTOP=1, RUNNING=2 } nfsuserd_state; 844 845 typedef enum { UNKNOWN=0, DELETED=1, NLINK_ZERO=2, VALID=3 } nfsremove_status; 846 847 /* Values for supports_nfsv4acls. */ 848 #define SUPPACL_NONE 0 849 #define SUPPACL_NFSV4 1 850 #define SUPPACL_POSIX 2 851 852 /* Values NFSv4 uses for exclusive_flag. */ 853 #define NFSV4_EXCLUSIVE_NONE 0 854 #define NFSV4_EXCLUSIVE 1 855 #define NFSV4_EXCLUSIVE_41 2 856 857 #endif /* _KERNEL */ 858 859 #endif /* _NFS_NFS_H */ 860