1 /*- 2 * Copyright (c) 1989, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * This code is derived from software contributed to Berkeley by 6 * Rick Macklem at The University of Guelph. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 4. Neither the name of the University nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30 * SUCH DAMAGE. 31 * 32 * $FreeBSD$ 33 */ 34 35 #ifndef _NFS_NFSPORT_H_ 36 #define _NFS_NFSPORT_H_ 37 38 /* 39 * In general, I'm not fond of #includes in .h files, but this seems 40 * to be the cleanest way to handle #include files for the ports. 41 */ 42 #ifdef _KERNEL 43 #include <sys/unistd.h> 44 #include <sys/param.h> 45 #include <sys/systm.h> 46 #include <sys/conf.h> 47 #include <sys/dirent.h> 48 #include <sys/domain.h> 49 #include <sys/fcntl.h> 50 #include <sys/file.h> 51 #include <sys/filedesc.h> 52 #include <sys/jail.h> 53 #include <sys/kernel.h> 54 #include <sys/lockf.h> 55 #include <sys/malloc.h> 56 #include <sys/mbuf.h> 57 #include <sys/mount.h> 58 #include <sys/mutex.h> 59 #include <sys/namei.h> 60 #include <sys/proc.h> 61 #include <sys/protosw.h> 62 #include <sys/reboot.h> 63 #include <sys/resourcevar.h> 64 #include <sys/signalvar.h> 65 #include <sys/socket.h> 66 #include <sys/socketvar.h> 67 #include <sys/stat.h> 68 #include <sys/syslog.h> 69 #include <sys/sysproto.h> 70 #include <sys/time.h> 71 #include <sys/uio.h> 72 #include <sys/vnode.h> 73 #include <sys/bio.h> 74 #include <sys/buf.h> 75 #include <sys/acl.h> 76 #include <sys/module.h> 77 #include <sys/sysent.h> 78 #include <sys/syscall.h> 79 #include <sys/priv.h> 80 #include <sys/kthread.h> 81 #include <sys/syscallsubr.h> 82 #include <net/if.h> 83 #include <net/if_var.h> 84 #include <net/radix.h> 85 #include <net/route.h> 86 #include <net/if_dl.h> 87 #include <netinet/in.h> 88 #include <netinet/in_pcb.h> 89 #include <netinet/in_systm.h> 90 #include <netinet/in_var.h> 91 #include <netinet/ip.h> 92 #include <netinet/ip_var.h> 93 #include <netinet/tcp.h> 94 #include <netinet/tcp_fsm.h> 95 #include <netinet/tcp_seq.h> 96 #include <netinet/tcp_timer.h> 97 #include <netinet/tcp_var.h> 98 #include <machine/in_cksum.h> 99 #include <crypto/des/des.h> 100 #include <sys/md5.h> 101 #include <rpc/rpc.h> 102 #include <rpc/rpcsec_gss.h> 103 104 #include <ufs/ufs/dir.h> 105 #include <ufs/ufs/quota.h> 106 #include <ufs/ufs/inode.h> 107 #include <ufs/ufs/extattr.h> 108 #include <ufs/ufs/ufsmount.h> 109 #include <vm/uma.h> 110 #include <vm/vm.h> 111 #include <vm/vm_object.h> 112 #include <vm/vm_extern.h> 113 #include <nfs/nfssvc.h> 114 #include "opt_nfs.h" 115 #include "opt_ufs.h" 116 117 /* 118 * These types must be defined before the nfs includes. 119 */ 120 #define NFSSOCKADDR_T struct sockaddr * 121 #define NFSPROC_T struct thread 122 #define NFSDEV_T dev_t 123 #define NFSSVCARGS nfssvc_args 124 #define NFSACL_T struct acl 125 126 /* 127 * These should be defined as the types used for the corresponding VOP's 128 * argument type. 129 */ 130 #define NFS_ACCESS_ARGS struct vop_access_args 131 #define NFS_OPEN_ARGS struct vop_open_args 132 #define NFS_GETATTR_ARGS struct vop_getattr_args 133 #define NFS_LOOKUP_ARGS struct vop_lookup_args 134 #define NFS_READDIR_ARGS struct vop_readdir_args 135 136 /* 137 * Allocate mbufs. Must succeed and never set the mbuf ptr to NULL. 138 */ 139 #define NFSMGET(m) do { \ 140 MGET((m), M_WAITOK, MT_DATA); \ 141 while ((m) == NULL ) { \ 142 (void) nfs_catnap(PZERO, 0, "nfsmget"); \ 143 MGET((m), M_WAITOK, MT_DATA); \ 144 } \ 145 } while (0) 146 #define NFSMGETHDR(m) do { \ 147 MGETHDR((m), M_WAITOK, MT_DATA); \ 148 while ((m) == NULL ) { \ 149 (void) nfs_catnap(PZERO, 0, "nfsmget"); \ 150 MGETHDR((m), M_WAITOK, MT_DATA); \ 151 } \ 152 } while (0) 153 #define NFSMCLGET(m, w) do { \ 154 MGET((m), M_WAITOK, MT_DATA); \ 155 while ((m) == NULL ) { \ 156 (void) nfs_catnap(PZERO, 0, "nfsmget"); \ 157 MGET((m), M_WAITOK, MT_DATA); \ 158 } \ 159 MCLGET((m), (w)); \ 160 } while (0) 161 #define NFSMCLGETHDR(m, w) do { \ 162 MGETHDR((m), M_WAITOK, MT_DATA); \ 163 while ((m) == NULL ) { \ 164 (void) nfs_catnap(PZERO, 0, "nfsmget"); \ 165 MGETHDR((m), M_WAITOK, MT_DATA); \ 166 } \ 167 } while (0) 168 #define NFSMTOD mtod 169 170 /* 171 * Client side constant for size of a lockowner name. 172 */ 173 #define NFSV4CL_LOCKNAMELEN 12 174 175 /* 176 * Type for a mutex lock. 177 */ 178 #define NFSMUTEX_T struct mtx 179 180 #endif /* _KERNEL */ 181 182 /* 183 * NFSv4 Operation numbers. 184 */ 185 #define NFSV4OP_ACCESS 3 186 #define NFSV4OP_CLOSE 4 187 #define NFSV4OP_COMMIT 5 188 #define NFSV4OP_CREATE 6 189 #define NFSV4OP_DELEGPURGE 7 190 #define NFSV4OP_DELEGRETURN 8 191 #define NFSV4OP_GETATTR 9 192 #define NFSV4OP_GETFH 10 193 #define NFSV4OP_LINK 11 194 #define NFSV4OP_LOCK 12 195 #define NFSV4OP_LOCKT 13 196 #define NFSV4OP_LOCKU 14 197 #define NFSV4OP_LOOKUP 15 198 #define NFSV4OP_LOOKUPP 16 199 #define NFSV4OP_NVERIFY 17 200 #define NFSV4OP_OPEN 18 201 #define NFSV4OP_OPENATTR 19 202 #define NFSV4OP_OPENCONFIRM 20 203 #define NFSV4OP_OPENDOWNGRADE 21 204 #define NFSV4OP_PUTFH 22 205 #define NFSV4OP_PUTPUBFH 23 206 #define NFSV4OP_PUTROOTFH 24 207 #define NFSV4OP_READ 25 208 #define NFSV4OP_READDIR 26 209 #define NFSV4OP_READLINK 27 210 #define NFSV4OP_REMOVE 28 211 #define NFSV4OP_RENAME 29 212 #define NFSV4OP_RENEW 30 213 #define NFSV4OP_RESTOREFH 31 214 #define NFSV4OP_SAVEFH 32 215 #define NFSV4OP_SECINFO 33 216 #define NFSV4OP_SETATTR 34 217 #define NFSV4OP_SETCLIENTID 35 218 #define NFSV4OP_SETCLIENTIDCFRM 36 219 #define NFSV4OP_VERIFY 37 220 #define NFSV4OP_WRITE 38 221 #define NFSV4OP_RELEASELCKOWN 39 222 223 /* 224 * Must be one greater than the last Operation#. 225 */ 226 #define NFSV4OP_NOPS 40 227 228 /* 229 * Additional Ops for NFSv4.1. 230 */ 231 #define NFSV4OP_BACKCHANNELCTL 40 232 #define NFSV4OP_BINDCONNTOSESS 41 233 #define NFSV4OP_EXCHANGEID 42 234 #define NFSV4OP_CREATESESSION 43 235 #define NFSV4OP_DESTROYSESSION 44 236 #define NFSV4OP_FREESTATEID 45 237 #define NFSV4OP_GETDIRDELEG 46 238 #define NFSV4OP_GETDEVINFO 47 239 #define NFSV4OP_GETDEVLIST 48 240 #define NFSV4OP_LAYOUTCOMMIT 49 241 #define NFSV4OP_LAYOUTGET 50 242 #define NFSV4OP_LAYOUTRETURN 51 243 #define NFSV4OP_SECINFONONAME 52 244 #define NFSV4OP_SEQUENCE 53 245 #define NFSV4OP_SETSSV 54 246 #define NFSV4OP_TESTSTATEID 55 247 #define NFSV4OP_WANTDELEG 56 248 #define NFSV4OP_DESTROYCLIENTID 57 249 #define NFSV4OP_RECLAIMCOMPL 58 250 251 /* 252 * Must be one more than last op#. 253 * NFSv4.2 isn't implemented yet, but define the op# limit for it. 254 */ 255 #define NFSV41_NOPS 59 256 #define NFSV42_NOPS 72 257 258 /* Quirky case if the illegal op code */ 259 #define NFSV4OP_OPILLEGAL 10044 260 261 /* 262 * Fake NFSV4OP_xxx used for nfsstat. Start at NFSV42_NOPS. 263 */ 264 #define NFSV4OP_SYMLINK (NFSV42_NOPS) 265 #define NFSV4OP_MKDIR (NFSV42_NOPS + 1) 266 #define NFSV4OP_RMDIR (NFSV42_NOPS + 2) 267 #define NFSV4OP_READDIRPLUS (NFSV42_NOPS + 3) 268 #define NFSV4OP_MKNOD (NFSV42_NOPS + 4) 269 #define NFSV4OP_FSSTAT (NFSV42_NOPS + 5) 270 #define NFSV4OP_FSINFO (NFSV42_NOPS + 6) 271 #define NFSV4OP_PATHCONF (NFSV42_NOPS + 7) 272 #define NFSV4OP_V3CREATE (NFSV42_NOPS + 8) 273 274 /* 275 * This is the count of the fake operations listed above. 276 */ 277 #define NFSV4OP_FAKENOPS 9 278 279 /* 280 * and the Callback OPs 281 */ 282 #define NFSV4OP_CBGETATTR 3 283 #define NFSV4OP_CBRECALL 4 284 285 /* 286 * Must be one greater than the last Callback Operation# for NFSv4.0. 287 */ 288 #define NFSV4OP_CBNOPS 5 289 290 /* 291 * Additional Callback Ops for NFSv4.1 only. 292 */ 293 #define NFSV4OP_CBLAYOUTRECALL 5 294 #define NFSV4OP_CBNOTIFY 6 295 #define NFSV4OP_CBPUSHDELEG 7 296 #define NFSV4OP_CBRECALLANY 8 297 #define NFSV4OP_CBRECALLOBJAVAIL 9 298 #define NFSV4OP_CBRECALLSLOT 10 299 #define NFSV4OP_CBSEQUENCE 11 300 #define NFSV4OP_CBWANTCANCELLED 12 301 #define NFSV4OP_CBNOTIFYLOCK 13 302 #define NFSV4OP_CBNOTIFYDEVID 14 303 304 #define NFSV41_CBNOPS 15 305 #define NFSV42_CBNOPS 16 306 307 /* 308 * The lower numbers -> 21 are used by NFSv2 and v3. These define higher 309 * numbers used by NFSv4. 310 * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is 311 * one greater than the last number. 312 */ 313 #ifndef NFS_V3NPROCS 314 #define NFS_V3NPROCS 22 315 316 #define NFSPROC_LOOKUPP 22 317 #define NFSPROC_SETCLIENTID 23 318 #define NFSPROC_SETCLIENTIDCFRM 24 319 #define NFSPROC_LOCK 25 320 #define NFSPROC_LOCKU 26 321 #define NFSPROC_OPEN 27 322 #define NFSPROC_CLOSE 28 323 #define NFSPROC_OPENCONFIRM 29 324 #define NFSPROC_LOCKT 30 325 #define NFSPROC_OPENDOWNGRADE 31 326 #define NFSPROC_RENEW 32 327 #define NFSPROC_PUTROOTFH 33 328 #define NFSPROC_RELEASELCKOWN 34 329 #define NFSPROC_DELEGRETURN 35 330 #define NFSPROC_RETDELEGREMOVE 36 331 #define NFSPROC_RETDELEGRENAME1 37 332 #define NFSPROC_RETDELEGRENAME2 38 333 #define NFSPROC_GETACL 39 334 #define NFSPROC_SETACL 40 335 336 /* 337 * Must be defined as one higher than the last Proc# above. 338 */ 339 #define NFSV4_NPROCS 41 340 341 /* Additional procedures for NFSv4.1. */ 342 #define NFSPROC_EXCHANGEID 41 343 #define NFSPROC_CREATESESSION 42 344 #define NFSPROC_DESTROYSESSION 43 345 #define NFSPROC_DESTROYCLIENT 44 346 #define NFSPROC_FREESTATEID 45 347 #define NFSPROC_LAYOUTGET 46 348 #define NFSPROC_GETDEVICEINFO 47 349 #define NFSPROC_LAYOUTCOMMIT 48 350 #define NFSPROC_LAYOUTRETURN 49 351 #define NFSPROC_RECLAIMCOMPL 50 352 #define NFSPROC_WRITEDS 51 353 #define NFSPROC_READDS 52 354 #define NFSPROC_COMMITDS 53 355 #define NFSPROC_OPENLAYGET 54 356 #define NFSPROC_CREATELAYGET 55 357 358 /* 359 * Must be defined as one higher than the last NFSv4.1 Proc# above. 360 */ 361 #define NFSV41_NPROCS 56 362 363 #endif /* NFS_V3NPROCS */ 364 365 /* 366 * New stats structure. 367 * The vers field will be set to NFSSTATS_V1 by the caller. 368 */ 369 #define NFSSTATS_V1 1 370 struct nfsstatsv1 { 371 int vers; /* Set to version requested by caller. */ 372 uint64_t attrcache_hits; 373 uint64_t attrcache_misses; 374 uint64_t lookupcache_hits; 375 uint64_t lookupcache_misses; 376 uint64_t direofcache_hits; 377 uint64_t direofcache_misses; 378 uint64_t accesscache_hits; 379 uint64_t accesscache_misses; 380 uint64_t biocache_reads; 381 uint64_t read_bios; 382 uint64_t read_physios; 383 uint64_t biocache_writes; 384 uint64_t write_bios; 385 uint64_t write_physios; 386 uint64_t biocache_readlinks; 387 uint64_t readlink_bios; 388 uint64_t biocache_readdirs; 389 uint64_t readdir_bios; 390 uint64_t rpccnt[NFSV41_NPROCS + 13]; 391 uint64_t rpcretries; 392 uint64_t srvrpccnt[NFSV42_NOPS + NFSV4OP_FAKENOPS]; 393 uint64_t srvrpc_errs; 394 uint64_t srv_errs; 395 uint64_t rpcrequests; 396 uint64_t rpctimeouts; 397 uint64_t rpcunexpected; 398 uint64_t rpcinvalid; 399 uint64_t srvcache_inproghits; 400 uint64_t srvcache_idemdonehits; 401 uint64_t srvcache_nonidemdonehits; 402 uint64_t srvcache_misses; 403 uint64_t srvcache_tcppeak; 404 int srvcache_size; /* Updated by atomic_xx_int(). */ 405 uint64_t srvclients; 406 uint64_t srvopenowners; 407 uint64_t srvopens; 408 uint64_t srvlockowners; 409 uint64_t srvlocks; 410 uint64_t srvdelegates; 411 uint64_t cbrpccnt[NFSV42_CBNOPS]; 412 uint64_t clopenowners; 413 uint64_t clopens; 414 uint64_t cllockowners; 415 uint64_t cllocks; 416 uint64_t cldelegates; 417 uint64_t cllocalopenowners; 418 uint64_t cllocalopens; 419 uint64_t cllocallockowners; 420 uint64_t cllocallocks; 421 uint64_t srvstartcnt; 422 uint64_t srvdonecnt; 423 uint64_t srvbytes[NFSV42_NOPS + NFSV4OP_FAKENOPS]; 424 uint64_t srvops[NFSV42_NOPS + NFSV4OP_FAKENOPS]; 425 struct bintime srvduration[NFSV42_NOPS + NFSV4OP_FAKENOPS]; 426 struct bintime busyfrom; 427 struct bintime busytime; 428 }; 429 430 /* 431 * Old stats structure. 432 */ 433 struct ext_nfsstats { 434 int attrcache_hits; 435 int attrcache_misses; 436 int lookupcache_hits; 437 int lookupcache_misses; 438 int direofcache_hits; 439 int direofcache_misses; 440 int accesscache_hits; 441 int accesscache_misses; 442 int biocache_reads; 443 int read_bios; 444 int read_physios; 445 int biocache_writes; 446 int write_bios; 447 int write_physios; 448 int biocache_readlinks; 449 int readlink_bios; 450 int biocache_readdirs; 451 int readdir_bios; 452 int rpccnt[NFSV4_NPROCS]; 453 int rpcretries; 454 int srvrpccnt[NFSV4OP_NOPS + NFSV4OP_FAKENOPS]; 455 int srvrpc_errs; 456 int srv_errs; 457 int rpcrequests; 458 int rpctimeouts; 459 int rpcunexpected; 460 int rpcinvalid; 461 int srvcache_inproghits; 462 int srvcache_idemdonehits; 463 int srvcache_nonidemdonehits; 464 int srvcache_misses; 465 int srvcache_tcppeak; 466 int srvcache_size; 467 int srvclients; 468 int srvopenowners; 469 int srvopens; 470 int srvlockowners; 471 int srvlocks; 472 int srvdelegates; 473 int cbrpccnt[NFSV4OP_CBNOPS]; 474 int clopenowners; 475 int clopens; 476 int cllockowners; 477 int cllocks; 478 int cldelegates; 479 int cllocalopenowners; 480 int cllocalopens; 481 int cllocallockowners; 482 int cllocallocks; 483 }; 484 485 #ifdef _KERNEL 486 /* 487 * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code. 488 */ 489 #ifndef NFS_NPROCS 490 #define NFS_NPROCS NFSV4_NPROCS 491 #endif 492 493 #include <fs/nfs/nfskpiport.h> 494 #include <fs/nfs/nfsdport.h> 495 #include <fs/nfs/rpcv2.h> 496 #include <fs/nfs/nfsproto.h> 497 #include <fs/nfs/nfs.h> 498 #include <fs/nfs/nfsclstate.h> 499 #include <fs/nfs/nfs_var.h> 500 #include <fs/nfs/nfsm_subs.h> 501 #include <fs/nfs/nfsrvcache.h> 502 #include <fs/nfs/nfsrvstate.h> 503 #include <fs/nfs/xdr_subs.h> 504 #include <fs/nfs/nfscl.h> 505 #include <nfsclient/nfsargs.h> 506 #include <fs/nfsclient/nfsmount.h> 507 508 /* 509 * Just to keep nfs_var.h happy. 510 */ 511 struct nfs_vattr { 512 int junk; 513 }; 514 515 struct nfsvattr { 516 struct vattr na_vattr; 517 nfsattrbit_t na_suppattr; 518 u_int32_t na_mntonfileno; 519 u_int64_t na_filesid[2]; 520 }; 521 522 #define na_type na_vattr.va_type 523 #define na_mode na_vattr.va_mode 524 #define na_nlink na_vattr.va_nlink 525 #define na_uid na_vattr.va_uid 526 #define na_gid na_vattr.va_gid 527 #define na_fsid na_vattr.va_fsid 528 #define na_fileid na_vattr.va_fileid 529 #define na_size na_vattr.va_size 530 #define na_blocksize na_vattr.va_blocksize 531 #define na_atime na_vattr.va_atime 532 #define na_mtime na_vattr.va_mtime 533 #define na_ctime na_vattr.va_ctime 534 #define na_gen na_vattr.va_gen 535 #define na_flags na_vattr.va_flags 536 #define na_rdev na_vattr.va_rdev 537 #define na_bytes na_vattr.va_bytes 538 #define na_filerev na_vattr.va_filerev 539 #define na_vaflags na_vattr.va_vaflags 540 541 #include <fs/nfsclient/nfsnode.h> 542 543 /* 544 * This is the header structure used for the lists, etc. (It has the 545 * above record in it. 546 */ 547 struct nfsrv_stablefirst { 548 LIST_HEAD(, nfsrv_stable) nsf_head; /* Head of nfsrv_stable list */ 549 time_t nsf_eograce; /* Time grace period ends */ 550 time_t *nsf_bootvals; /* Previous boottime values */ 551 struct file *nsf_fp; /* File table pointer */ 552 u_char nsf_flags; /* NFSNSF_ flags */ 553 struct nfsf_rec nsf_rec; /* and above first record */ 554 }; 555 #define nsf_lease nsf_rec.lease 556 #define nsf_numboots nsf_rec.numboots 557 558 /* NFSNSF_xxx flags */ 559 #define NFSNSF_UPDATEDONE 0x01 560 #define NFSNSF_GRACEOVER 0x02 561 #define NFSNSF_NEEDLOCK 0x04 562 #define NFSNSF_EXPIREDCLIENT 0x08 563 #define NFSNSF_NOOPENS 0x10 564 #define NFSNSF_OK 0x20 565 566 /* 567 * Maximum number of boot times allowed in record. Although there is 568 * really no need for a fixed upper bound, this serves as a sanity check 569 * for a corrupted file. 570 */ 571 #define NFSNSF_MAXNUMBOOTS 10000 572 573 /* 574 * This structure defines the other records in the file. The 575 * nst_client array is actually the size of the client string name. 576 */ 577 struct nfst_rec { 578 u_int16_t len; 579 u_char flag; 580 u_char client[1]; 581 }; 582 /* and the values for flag */ 583 #define NFSNST_NEWSTATE 0x1 584 #define NFSNST_REVOKE 0x2 585 #define NFSNST_GOTSTATE 0x4 586 #define NFSNST_RECLAIMED 0x8 587 588 /* 589 * This structure is linked onto nfsrv_stablefirst for the duration of 590 * reclaim. 591 */ 592 struct nfsrv_stable { 593 LIST_ENTRY(nfsrv_stable) nst_list; 594 struct nfsclient *nst_clp; 595 struct nfst_rec nst_rec; 596 }; 597 #define nst_timestamp nst_rec.timestamp 598 #define nst_len nst_rec.len 599 #define nst_flag nst_rec.flag 600 #define nst_client nst_rec.client 601 602 /* 603 * At some point the server will run out of kernel storage for 604 * state structures. For FreeBSD5.2, this results in a panic 605 * kmem_map is full. It happens at well over 1000000 opens plus 606 * locks on a PIII-800 with 256Mbytes, so that is where I've set 607 * the limit. If your server panics due to too many opens/locks, 608 * decrease the size of NFSRV_V4STATELIMIT. If you find the server 609 * returning NFS4ERR_RESOURCE a lot and have lots of memory, try 610 * increasing it. 611 */ 612 #define NFSRV_V4STATELIMIT 500000 /* Max # of Opens + Locks */ 613 614 /* 615 * The type required differs with BSDen (just the second arg). 616 */ 617 void nfsrvd_rcv(struct socket *, void *, int); 618 619 /* 620 * Macros for handling socket addresses. (Hopefully this makes the code 621 * more portable, since I've noticed some 'BSD don't have sockaddrs in 622 * mbufs any more.) 623 */ 624 #define NFSSOCKADDR(a, t) ((t)(a)) 625 #define NFSSOCKADDRALLOC(a) \ 626 do { \ 627 MALLOC((a), struct sockaddr *, sizeof (struct sockaddr), \ 628 M_SONAME, M_WAITOK); \ 629 NFSBZERO((a), sizeof (struct sockaddr)); \ 630 } while (0) 631 #define NFSSOCKADDRSIZE(a, s) ((a)->sa_len = (s)) 632 #define NFSSOCKADDRFREE(a) \ 633 do { \ 634 if (a) \ 635 FREE((caddr_t)(a), M_SONAME); \ 636 } while (0) 637 638 /* 639 * These should be defined as a process or thread structure, as required 640 * for signal handling, etc. 641 */ 642 #define NFSNEWCRED(c) (crdup(c)) 643 #define NFSPROCCRED(p) ((p)->td_ucred) 644 #define NFSFREECRED(c) (crfree(c)) 645 #define NFSUIOPROC(u, p) ((u)->uio_td = NULL) 646 #define NFSPROCP(p) ((p)->td_proc) 647 648 /* 649 * Define these so that cn_hash and its length is ignored. 650 */ 651 #define NFSCNHASHZERO(c) 652 #define NFSCNHASH(c, v) 653 #define NCHNAMLEN 9999999 654 655 /* 656 * These macros are defined to initialize and set the timer routine. 657 */ 658 #define NFS_TIMERINIT \ 659 newnfs_timer(NULL) 660 661 /* 662 * Handle SMP stuff: 663 */ 664 #define NFSSTATESPINLOCK extern struct mtx nfs_state_mutex 665 #define NFSLOCKSTATE() mtx_lock(&nfs_state_mutex) 666 #define NFSUNLOCKSTATE() mtx_unlock(&nfs_state_mutex) 667 #define NFSSTATEMUTEXPTR (&nfs_state_mutex) 668 #define NFSREQSPINLOCK extern struct mtx nfs_req_mutex 669 #define NFSLOCKREQ() mtx_lock(&nfs_req_mutex) 670 #define NFSUNLOCKREQ() mtx_unlock(&nfs_req_mutex) 671 #define NFSSOCKMUTEX extern struct mtx nfs_slock_mutex 672 #define NFSSOCKMUTEXPTR (&nfs_slock_mutex) 673 #define NFSLOCKSOCK() mtx_lock(&nfs_slock_mutex) 674 #define NFSUNLOCKSOCK() mtx_unlock(&nfs_slock_mutex) 675 #define NFSNAMEIDMUTEX extern struct mtx nfs_nameid_mutex 676 #define NFSNAMEIDMUTEXPTR (&nfs_nameid_mutex) 677 #define NFSLOCKNAMEID() mtx_lock(&nfs_nameid_mutex) 678 #define NFSUNLOCKNAMEID() mtx_unlock(&nfs_nameid_mutex) 679 #define NFSNAMEIDREQUIRED() mtx_assert(&nfs_nameid_mutex, MA_OWNED) 680 #define NFSCLSTATEMUTEX extern struct mtx nfs_clstate_mutex 681 #define NFSCLSTATEMUTEXPTR (&nfs_clstate_mutex) 682 #define NFSLOCKCLSTATE() mtx_lock(&nfs_clstate_mutex) 683 #define NFSUNLOCKCLSTATE() mtx_unlock(&nfs_clstate_mutex) 684 #define NFSDLOCKMUTEX extern struct mtx newnfsd_mtx 685 #define NFSDLOCKMUTEXPTR (&newnfsd_mtx) 686 #define NFSD_LOCK() mtx_lock(&newnfsd_mtx) 687 #define NFSD_UNLOCK() mtx_unlock(&newnfsd_mtx) 688 #define NFSD_LOCK_ASSERT() mtx_assert(&newnfsd_mtx, MA_OWNED) 689 #define NFSD_UNLOCK_ASSERT() mtx_assert(&newnfsd_mtx, MA_NOTOWNED) 690 #define NFSV4ROOTLOCKMUTEX extern struct mtx nfs_v4root_mutex 691 #define NFSV4ROOTLOCKMUTEXPTR (&nfs_v4root_mutex) 692 #define NFSLOCKV4ROOTMUTEX() mtx_lock(&nfs_v4root_mutex) 693 #define NFSUNLOCKV4ROOTMUTEX() mtx_unlock(&nfs_v4root_mutex) 694 #define NFSLOCKNODE(n) mtx_lock(&((n)->n_mtx)) 695 #define NFSUNLOCKNODE(n) mtx_unlock(&((n)->n_mtx)) 696 #define NFSLOCKMNT(m) mtx_lock(&((m)->nm_mtx)) 697 #define NFSUNLOCKMNT(m) mtx_unlock(&((m)->nm_mtx)) 698 #define NFSLOCKREQUEST(r) mtx_lock(&((r)->r_mtx)) 699 #define NFSUNLOCKREQUEST(r) mtx_unlock(&((r)->r_mtx)) 700 #define NFSPROCLISTLOCK() sx_slock(&allproc_lock) 701 #define NFSPROCLISTUNLOCK() sx_sunlock(&allproc_lock) 702 #define NFSLOCKSOCKREQ(r) mtx_lock(&((r)->nr_mtx)) 703 #define NFSUNLOCKSOCKREQ(r) mtx_unlock(&((r)->nr_mtx)) 704 #define NFSLOCKDS(d) mtx_lock(&((d)->nfsclds_mtx)) 705 #define NFSUNLOCKDS(d) mtx_unlock(&((d)->nfsclds_mtx)) 706 #define NFSSESSIONMUTEXPTR(s) (&((s)->mtx)) 707 #define NFSLOCKSESSION(s) mtx_lock(&((s)->mtx)) 708 #define NFSUNLOCKSESSION(s) mtx_unlock(&((s)->mtx)) 709 710 /* 711 * Use these macros to initialize/free a mutex. 712 */ 713 #define NFSINITSOCKMUTEX(m) mtx_init((m), "nfssock", NULL, MTX_DEF) 714 #define NFSFREEMUTEX(m) mtx_destroy((m)) 715 716 int nfsmsleep(void *, void *, int, const char *, struct timespec *); 717 718 /* 719 * And weird vm stuff in the nfs server. 720 */ 721 #define PDIRUNLOCK 0x0 722 #define MAX_COMMIT_COUNT (1024 * 1024) 723 724 /* 725 * Define these to handle the type of va_rdev. 726 */ 727 #define NFSMAKEDEV(m, n) makedev((m), (n)) 728 #define NFSMAJOR(d) major(d) 729 #define NFSMINOR(d) minor(d) 730 731 /* 732 * Define this to be the macro that returns the minimum size required 733 * for a directory entry. 734 */ 735 #define DIRENT_SIZE(dp) GENERIC_DIRSIZ(dp) 736 737 /* 738 * The vnode tag for nfsv4root. 739 */ 740 #define VT_NFSV4ROOT "nfsv4root" 741 742 /* 743 * Define whatever it takes to do a vn_rdwr(). 744 */ 745 #define NFSD_RDWR(r, v, b, l, o, s, i, c, a, p) \ 746 vn_rdwr((r), (v), (b), (l), (o), (s), (i), (c), NULL, (a), (p)) 747 748 /* 749 * Macros for handling memory for different BSDen. 750 * NFSBCOPY(src, dst, len) - copies len bytes, non-overlapping 751 * NFSOVBCOPY(src, dst, len) - ditto, but data areas might overlap 752 * NFSBCMP(cp1, cp2, len) - compare len bytes, return 0 if same 753 * NFSBZERO(cp, len) - set len bytes to 0x0 754 */ 755 #define NFSBCOPY(s, d, l) bcopy((s), (d), (l)) 756 #define NFSOVBCOPY(s, d, l) ovbcopy((s), (d), (l)) 757 #define NFSBCMP(s, d, l) bcmp((s), (d), (l)) 758 #define NFSBZERO(s, l) bzero((s), (l)) 759 760 /* 761 * Some queue.h files don't have these dfined in them. 762 */ 763 #define LIST_END(head) NULL 764 #define SLIST_END(head) NULL 765 #define TAILQ_END(head) NULL 766 767 /* 768 * This must be defined to be a global variable that increments once 769 * per second, but never stops or goes backwards, even when a "date" 770 * command changes the TOD clock. It is used for delta times for 771 * leases, etc. 772 */ 773 #define NFSD_MONOSEC time_uptime 774 775 /* 776 * Declare the malloc types. 777 */ 778 MALLOC_DECLARE(M_NEWNFSRVCACHE); 779 MALLOC_DECLARE(M_NEWNFSDCLIENT); 780 MALLOC_DECLARE(M_NEWNFSDSTATE); 781 MALLOC_DECLARE(M_NEWNFSDLOCK); 782 MALLOC_DECLARE(M_NEWNFSDLOCKFILE); 783 MALLOC_DECLARE(M_NEWNFSSTRING); 784 MALLOC_DECLARE(M_NEWNFSUSERGROUP); 785 MALLOC_DECLARE(M_NEWNFSDREQ); 786 MALLOC_DECLARE(M_NEWNFSFH); 787 MALLOC_DECLARE(M_NEWNFSCLOWNER); 788 MALLOC_DECLARE(M_NEWNFSCLOPEN); 789 MALLOC_DECLARE(M_NEWNFSCLDELEG); 790 MALLOC_DECLARE(M_NEWNFSCLCLIENT); 791 MALLOC_DECLARE(M_NEWNFSCLLOCKOWNER); 792 MALLOC_DECLARE(M_NEWNFSCLLOCK); 793 MALLOC_DECLARE(M_NEWNFSDIROFF); 794 MALLOC_DECLARE(M_NEWNFSV4NODE); 795 MALLOC_DECLARE(M_NEWNFSDIRECTIO); 796 MALLOC_DECLARE(M_NEWNFSMNT); 797 MALLOC_DECLARE(M_NEWNFSDROLLBACK); 798 MALLOC_DECLARE(M_NEWNFSLAYOUT); 799 MALLOC_DECLARE(M_NEWNFSFLAYOUT); 800 MALLOC_DECLARE(M_NEWNFSDEVINFO); 801 MALLOC_DECLARE(M_NEWNFSSOCKREQ); 802 MALLOC_DECLARE(M_NEWNFSCLDS); 803 MALLOC_DECLARE(M_NEWNFSLAYRECALL); 804 MALLOC_DECLARE(M_NEWNFSDSESSION); 805 #define M_NFSRVCACHE M_NEWNFSRVCACHE 806 #define M_NFSDCLIENT M_NEWNFSDCLIENT 807 #define M_NFSDSTATE M_NEWNFSDSTATE 808 #define M_NFSDLOCK M_NEWNFSDLOCK 809 #define M_NFSDLOCKFILE M_NEWNFSDLOCKFILE 810 #define M_NFSSTRING M_NEWNFSSTRING 811 #define M_NFSUSERGROUP M_NEWNFSUSERGROUP 812 #define M_NFSDREQ M_NEWNFSDREQ 813 #define M_NFSFH M_NEWNFSFH 814 #define M_NFSCLOWNER M_NEWNFSCLOWNER 815 #define M_NFSCLOPEN M_NEWNFSCLOPEN 816 #define M_NFSCLDELEG M_NEWNFSCLDELEG 817 #define M_NFSCLCLIENT M_NEWNFSCLCLIENT 818 #define M_NFSCLLOCKOWNER M_NEWNFSCLLOCKOWNER 819 #define M_NFSCLLOCK M_NEWNFSCLLOCK 820 #define M_NFSDIROFF M_NEWNFSDIROFF 821 #define M_NFSV4NODE M_NEWNFSV4NODE 822 #define M_NFSDIRECTIO M_NEWNFSDIRECTIO 823 #define M_NFSDROLLBACK M_NEWNFSDROLLBACK 824 #define M_NFSLAYOUT M_NEWNFSLAYOUT 825 #define M_NFSFLAYOUT M_NEWNFSFLAYOUT 826 #define M_NFSDEVINFO M_NEWNFSDEVINFO 827 #define M_NFSSOCKREQ M_NEWNFSSOCKREQ 828 #define M_NFSCLDS M_NEWNFSCLDS 829 #define M_NFSLAYRECALL M_NEWNFSLAYRECALL 830 #define M_NFSDSESSION M_NEWNFSDSESSION 831 832 #define NFSINT_SIGMASK(set) \ 833 (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) || \ 834 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) || \ 835 SIGISMEMBER(set, SIGQUIT)) 836 837 /* 838 * Convert a quota block count to byte count. 839 */ 840 #define NFSQUOTABLKTOBYTE(q, b) (q) *= (b) 841 842 /* 843 * Define this as the largest file size supported. (It should probably 844 * be available via a VFS_xxx Op, but it isn't. 845 */ 846 #define NFSRV_MAXFILESIZE ((u_int64_t)0x800000000000) 847 848 /* 849 * Set this macro to index() or strchr(), whichever is supported. 850 */ 851 #define STRCHR(s, c) strchr((s), (c)) 852 853 /* 854 * Set the n_time in the client write rpc, as required. 855 */ 856 #define NFSWRITERPC_SETTIME(w, n, a, v4) \ 857 do { \ 858 if (w) { \ 859 mtx_lock(&((n)->n_mtx)); \ 860 (n)->n_mtime = (a)->na_mtime; \ 861 if (v4) \ 862 (n)->n_change = (a)->na_filerev; \ 863 mtx_unlock(&((n)->n_mtx)); \ 864 } \ 865 } while (0) 866 867 /* 868 * Fake value, just to make the client work. 869 */ 870 #define NFS_LATTR_NOSHRINK 1 871 872 /* 873 * Prototypes for functions where the arguments vary for different ports. 874 */ 875 int nfscl_loadattrcache(struct vnode **, struct nfsvattr *, void *, void *, 876 int, int); 877 int newnfs_realign(struct mbuf **, int); 878 879 /* 880 * If the port runs on an SMP box that can enforce Atomic ops with low 881 * overheads, define these as atomic increments/decrements. If not, 882 * don't worry about it, since these are used for stats that can be 883 * "out by one" without disastrous consequences. 884 */ 885 #define NFSINCRGLOBAL(a) ((a)++) 886 887 /* 888 * Assorted funky stuff to make things work under Darwin8. 889 */ 890 /* 891 * These macros checks for a field in vattr being set. 892 */ 893 #define NFSATTRISSET(t, v, a) ((v)->a != (t)VNOVAL) 894 #define NFSATTRISSETTIME(v, a) ((v)->a.tv_sec != VNOVAL) 895 896 /* 897 * Manipulate mount flags. 898 */ 899 #define NFSSTA_HASWRITEVERF 0x00040000 /* Has write verifier */ 900 #define NFSSTA_GOTFSINFO 0x00100000 /* Got the fsinfo */ 901 #define NFSSTA_OPENMODE 0x00200000 /* Must use correct open mode */ 902 #define NFSSTA_NOLAYOUTCOMMIT 0x04000000 /* Don't do LayoutCommit */ 903 #define NFSSTA_SESSPERSIST 0x08000000 /* Has a persistent session */ 904 #define NFSSTA_TIMEO 0x10000000 /* Experiencing a timeout */ 905 #define NFSSTA_LOCKTIMEO 0x20000000 /* Experiencing a lockd timeout */ 906 #define NFSSTA_HASSETFSID 0x40000000 /* Has set the fsid */ 907 #define NFSSTA_PNFS 0x80000000 /* pNFS is enabled */ 908 909 #define NFSHASNFSV3(n) ((n)->nm_flag & NFSMNT_NFSV3) 910 #define NFSHASNFSV4(n) ((n)->nm_flag & NFSMNT_NFSV4) 911 #define NFSHASNFSV4N(n) ((n)->nm_minorvers > 0) 912 #define NFSHASNFSV3OR4(n) ((n)->nm_flag & (NFSMNT_NFSV3 | NFSMNT_NFSV4)) 913 #define NFSHASGOTFSINFO(n) ((n)->nm_state & NFSSTA_GOTFSINFO) 914 #define NFSHASHASSETFSID(n) ((n)->nm_state & NFSSTA_HASSETFSID) 915 #define NFSHASSTRICT3530(n) ((n)->nm_flag & NFSMNT_STRICT3530) 916 #define NFSHASWRITEVERF(n) ((n)->nm_state & NFSSTA_HASWRITEVERF) 917 #define NFSHASINT(n) ((n)->nm_flag & NFSMNT_INT) 918 #define NFSHASSOFT(n) ((n)->nm_flag & NFSMNT_SOFT) 919 #define NFSHASINTORSOFT(n) ((n)->nm_flag & (NFSMNT_INT | NFSMNT_SOFT)) 920 #define NFSHASDUMBTIMR(n) ((n)->nm_flag & NFSMNT_DUMBTIMR) 921 #define NFSHASNOCONN(n) ((n)->nm_flag & NFSMNT_MNTD) 922 #define NFSHASKERB(n) ((n)->nm_flag & NFSMNT_KERB) 923 #define NFSHASALLGSSNAME(n) ((n)->nm_flag & NFSMNT_ALLGSSNAME) 924 #define NFSHASINTEGRITY(n) ((n)->nm_flag & NFSMNT_INTEGRITY) 925 #define NFSHASPRIVACY(n) ((n)->nm_flag & NFSMNT_PRIVACY) 926 #define NFSSETWRITEVERF(n) ((n)->nm_state |= NFSSTA_HASWRITEVERF) 927 #define NFSSETHASSETFSID(n) ((n)->nm_state |= NFSSTA_HASSETFSID) 928 #define NFSHASPNFSOPT(n) ((n)->nm_flag & NFSMNT_PNFS) 929 #define NFSHASNOLAYOUTCOMMIT(n) ((n)->nm_state & NFSSTA_NOLAYOUTCOMMIT) 930 #define NFSHASSESSPERSIST(n) ((n)->nm_state & NFSSTA_SESSPERSIST) 931 #define NFSHASPNFS(n) ((n)->nm_state & NFSSTA_PNFS) 932 #define NFSHASOPENMODE(n) ((n)->nm_state & NFSSTA_OPENMODE) 933 #define NFSHASONEOPENOWN(n) (((n)->nm_flag & NFSMNT_ONEOPENOWN) != 0 && \ 934 (n)->nm_minorvers > 0) 935 936 /* 937 * Gets the stats field out of the mount structure. 938 */ 939 #define vfs_statfs(m) (&((m)->mnt_stat)) 940 941 /* 942 * Set boottime. 943 */ 944 #define NFSSETBOOTTIME(b) (getboottime(&b)) 945 946 /* 947 * The size of directory blocks in the buffer cache. 948 * MUST BE in the range of PAGE_SIZE <= NFS_DIRBLKSIZ <= MAXBSIZE!! 949 */ 950 #define NFS_DIRBLKSIZ (16 * DIRBLKSIZ) /* Must be a multiple of DIRBLKSIZ */ 951 952 /* 953 * Define these macros to access mnt_flag fields. 954 */ 955 #define NFSMNT_RDONLY(m) ((m)->mnt_flag & MNT_RDONLY) 956 #endif /* _KERNEL */ 957 958 /* 959 * Define a structure similar to ufs_args for use in exporting the V4 root. 960 */ 961 struct nfsex_args { 962 char *fspec; 963 struct export_args export; 964 }; 965 966 /* 967 * These export flags should be defined, but there are no bits left. 968 * Maybe a separate mnt_exflag field could be added or the mnt_flag 969 * field increased to 64 bits? 970 */ 971 #ifndef MNT_EXSTRICTACCESS 972 #define MNT_EXSTRICTACCESS 0x0 973 #endif 974 #ifndef MNT_EXV4ONLY 975 #define MNT_EXV4ONLY 0x0 976 #endif 977 978 #ifdef _KERNEL 979 /* 980 * Define this to invalidate the attribute cache for the nfs node. 981 */ 982 #define NFSINVALATTRCACHE(n) ((n)->n_attrstamp = 0) 983 984 /* Used for FreeBSD only */ 985 void nfsd_mntinit(void); 986 987 /* 988 * Define these for vnode lock/unlock ops. 989 * 990 * These are good abstractions to macro out, so that they can be added to 991 * later, for debugging or stats, etc. 992 */ 993 #define NFSVOPLOCK(v, f) vn_lock((v), (f)) 994 #define NFSVOPUNLOCK(v, f) VOP_UNLOCK((v), (f)) 995 #define NFSVOPISLOCKED(v) VOP_ISLOCKED((v)) 996 997 /* 998 * Define ncl_hash(). 999 */ 1000 #define ncl_hash(f, l) (fnv_32_buf((f), (l), FNV1_32_INIT)) 1001 1002 int newnfs_iosize(struct nfsmount *); 1003 1004 int newnfs_vncmpf(struct vnode *, void *); 1005 1006 #ifndef NFS_MINDIRATTRTIMO 1007 #define NFS_MINDIRATTRTIMO 3 /* VDIR attrib cache timeout in sec */ 1008 #endif 1009 #ifndef NFS_MAXDIRATTRTIMO 1010 #define NFS_MAXDIRATTRTIMO 60 1011 #endif 1012 1013 /* 1014 * Nfs outstanding request list element 1015 */ 1016 struct nfsreq { 1017 TAILQ_ENTRY(nfsreq) r_chain; 1018 u_int32_t r_flags; /* flags on request, see below */ 1019 struct nfsmount *r_nmp; /* Client mnt ptr */ 1020 struct mtx r_mtx; /* Mutex lock for this structure */ 1021 }; 1022 1023 #ifndef NFS_MAXBSIZE 1024 #define NFS_MAXBSIZE (maxbcachebuf) 1025 #endif 1026 1027 /* 1028 * This macro checks to see if issuing of delegations is allowed for this 1029 * vnode. 1030 */ 1031 #ifdef VV_DISABLEDELEG 1032 #define NFSVNO_DELEGOK(v) \ 1033 ((v) == NULL || ((v)->v_vflag & VV_DISABLEDELEG) == 0) 1034 #else 1035 #define NFSVNO_DELEGOK(v) (1) 1036 #endif 1037 1038 /* 1039 * Name used by getnewvnode() to describe filesystem, "nfs". 1040 * For performance reasons it is useful to have the same string 1041 * used in both places that call getnewvnode(). 1042 */ 1043 extern const char nfs_vnode_tag[]; 1044 1045 #endif /* _KERNEL */ 1046 1047 #endif /* _NFS_NFSPORT_H */ 1048