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