nfsport.h revision 194357
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: head/sys/fs/nfs/nfsport.h 194357 2009-06-17 12:44:11Z bz $ 33 */ 34 35#ifndef _NFS_NFSPORT_H_ 36#define _NFSPORT_NFS_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/namei.h> 59#include <sys/proc.h> 60#include <sys/protosw.h> 61#include <sys/reboot.h> 62#include <sys/resourcevar.h> 63#include <sys/signalvar.h> 64#include <sys/socket.h> 65#include <sys/socketvar.h> 66#include <sys/stat.h> 67#include <sys/syslog.h> 68#include <sys/sysproto.h> 69#include <sys/time.h> 70#include <sys/uio.h> 71#include <sys/vnode.h> 72#include <sys/bio.h> 73#include <sys/buf.h> 74#include <sys/acl.h> 75#include <sys/module.h> 76#include <sys/sysent.h> 77#include <sys/syscall.h> 78#include <sys/priv.h> 79#include <sys/kthread.h> 80#include <sys/syscallsubr.h> 81#include <sys/vimage.h> 82#include <fs/fifofs/fifo.h> 83#include <net/if.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 <netinet/vinet.h> 99#include <machine/in_cksum.h> 100#include <crypto/des/des.h> 101#include <sys/md5.h> 102#include <rpc/rpc.h> 103#include <rpc/rpcsec_gss.h> 104 105/* 106 * For Darwin, these functions should be "static" when built in a kext. 107 * (This is always defined as nil otherwise.) 108 */ 109#define APPLESTATIC 110#include <ufs/ufs/dir.h> 111#include <ufs/ufs/quota.h> 112#include <ufs/ufs/inode.h> 113#include <ufs/ufs/extattr.h> 114#include <ufs/ufs/ufsmount.h> 115#include <vm/uma.h> 116#include <vm/vm.h> 117#include <vm/vm_object.h> 118#include <vm/vm_extern.h> 119#include <nfs/nfssvc.h> 120#include "opt_nfs.h" 121#include "opt_ufs.h" 122 123/* 124 * These types must be defined before the nfs includes. 125 */ 126#define NFSSOCKADDR_T struct sockaddr * 127#define NFSPROC_T struct thread 128#define NFSDEV_T dev_t 129#define NFSSVCARGS nfssvc_args 130#ifdef NFS4_ACL_EXTATTR_NAME 131#define NFSACL_T struct acl 132#else 133#define NFSACL_T void 134#endif 135 136/* 137 * These should be defined as the types used for the corresponding VOP's 138 * argument type. 139 */ 140#define NFS_ACCESS_ARGS struct vop_access_args 141#define NFS_OPEN_ARGS struct vop_open_args 142#define NFS_GETATTR_ARGS struct vop_getattr_args 143#define NFS_LOOKUP_ARGS struct vop_lookup_args 144#define NFS_READDIR_ARGS struct vop_readdir_args 145 146/* 147 * Allocate mbufs. Must succeed and never set the mbuf ptr to NULL. 148 */ 149#define NFSMGET(m) do { \ 150 MGET((m), M_TRYWAIT, MT_DATA); \ 151 while ((m) == NULL ) { \ 152 (void) nfs_catnap(PZERO, "nfsmget"); \ 153 MGET((m), M_TRYWAIT, MT_DATA); \ 154 } \ 155 } while (0) 156#define NFSMGETHDR(m) do { \ 157 MGETHDR((m), M_TRYWAIT, MT_DATA); \ 158 while ((m) == NULL ) { \ 159 (void) nfs_catnap(PZERO, "nfsmget"); \ 160 MGETHDR((m), M_TRYWAIT, MT_DATA); \ 161 } \ 162 } while (0) 163#define NFSMCLGET(m, w) do { \ 164 MGET((m), M_TRYWAIT, MT_DATA); \ 165 while ((m) == NULL ) { \ 166 (void) nfs_catnap(PZERO, "nfsmget"); \ 167 MGET((m), M_TRYWAIT, MT_DATA); \ 168 } \ 169 MCLGET((m), (w)); \ 170 } while (0) 171#define NFSMCLGETHDR(m, w) do { \ 172 MGETHDR((m), M_TRYWAIT, MT_DATA); \ 173 while ((m) == NULL ) { \ 174 (void) nfs_catnap(PZERO, "nfsmget"); \ 175 MGETHDR((m), M_TRYWAIT, MT_DATA); \ 176 } \ 177 } while (0) 178#define NFSMTOD mtod 179 180/* 181 * Client side constant for size of a lockowner name. 182 */ 183#define NFSV4CL_LOCKNAMELEN 12 184 185/* 186 * Type for a mutex lock. 187 */ 188#define NFSMUTEX_T struct mtx 189 190#endif /* _KERNEL */ 191 192/* 193 * NFSv4 Operation numbers. 194 */ 195#define NFSV4OP_ACCESS 3 196#define NFSV4OP_CLOSE 4 197#define NFSV4OP_COMMIT 5 198#define NFSV4OP_CREATE 6 199#define NFSV4OP_DELEGPURGE 7 200#define NFSV4OP_DELEGRETURN 8 201#define NFSV4OP_GETATTR 9 202#define NFSV4OP_GETFH 10 203#define NFSV4OP_LINK 11 204#define NFSV4OP_LOCK 12 205#define NFSV4OP_LOCKT 13 206#define NFSV4OP_LOCKU 14 207#define NFSV4OP_LOOKUP 15 208#define NFSV4OP_LOOKUPP 16 209#define NFSV4OP_NVERIFY 17 210#define NFSV4OP_OPEN 18 211#define NFSV4OP_OPENATTR 19 212#define NFSV4OP_OPENCONFIRM 20 213#define NFSV4OP_OPENDOWNGRADE 21 214#define NFSV4OP_PUTFH 22 215#define NFSV4OP_PUTPUBFH 23 216#define NFSV4OP_PUTROOTFH 24 217#define NFSV4OP_READ 25 218#define NFSV4OP_READDIR 26 219#define NFSV4OP_READLINK 27 220#define NFSV4OP_REMOVE 28 221#define NFSV4OP_RENAME 29 222#define NFSV4OP_RENEW 30 223#define NFSV4OP_RESTOREFH 31 224#define NFSV4OP_SAVEFH 32 225#define NFSV4OP_SECINFO 33 226#define NFSV4OP_SETATTR 34 227#define NFSV4OP_SETCLIENTID 35 228#define NFSV4OP_SETCLIENTIDCFRM 36 229#define NFSV4OP_VERIFY 37 230#define NFSV4OP_WRITE 38 231#define NFSV4OP_RELEASELCKOWN 39 232 233/* 234 * Must be one greater than the last Operation#. 235 */ 236#define NFSV4OP_NOPS 40 237 238/* Quirky case if the illegal op code */ 239#define NFSV4OP_OPILLEGAL 10044 240 241/* 242 * Fake NFSV4OP_xxx used for nfsstat. Start at NFSV4OP_NOPS. 243 */ 244#define NFSV4OP_SYMLINK (NFSV4OP_NOPS) 245#define NFSV4OP_MKDIR (NFSV4OP_NOPS + 1) 246#define NFSV4OP_RMDIR (NFSV4OP_NOPS + 2) 247#define NFSV4OP_READDIRPLUS (NFSV4OP_NOPS + 3) 248#define NFSV4OP_MKNOD (NFSV4OP_NOPS + 4) 249#define NFSV4OP_FSSTAT (NFSV4OP_NOPS + 5) 250#define NFSV4OP_FSINFO (NFSV4OP_NOPS + 6) 251#define NFSV4OP_PATHCONF (NFSV4OP_NOPS + 7) 252#define NFSV4OP_V3CREATE (NFSV4OP_NOPS + 8) 253 254/* 255 * This is the count of the fake operations listed above. 256 */ 257#define NFSV4OP_FAKENOPS 9 258 259/* 260 * and the Callback OPs 261 */ 262#define NFSV4OP_CBGETATTR 3 263#define NFSV4OP_CBRECALL 4 264 265/* 266 * Must be one greater than the last Callback Operation#. 267 */ 268#define NFSV4OP_CBNOPS 5 269 270/* 271 * The lower numbers -> 21 are used by NFSv2 and v3. These define higher 272 * numbers used by NFSv4. 273 * NFS_V3NPROCS is one greater than the last V3 op and NFS_NPROCS is 274 * one greater than the last number. 275 */ 276#define NFS_V3NPROCS 22 277 278#define NFSPROC_LOOKUPP 22 279#define NFSPROC_SETCLIENTID 23 280#define NFSPROC_SETCLIENTIDCFRM 24 281#define NFSPROC_LOCK 25 282#define NFSPROC_LOCKU 26 283#define NFSPROC_OPEN 27 284#define NFSPROC_CLOSE 28 285#define NFSPROC_OPENCONFIRM 29 286#define NFSPROC_LOCKT 30 287#define NFSPROC_OPENDOWNGRADE 31 288#define NFSPROC_RENEW 32 289#define NFSPROC_PUTROOTFH 33 290#define NFSPROC_RELEASELCKOWN 34 291#define NFSPROC_DELEGRETURN 35 292#define NFSPROC_RETDELEGREMOVE 36 293#define NFSPROC_RETDELEGRENAME1 37 294#define NFSPROC_RETDELEGRENAME2 38 295#define NFSPROC_GETACL 39 296#define NFSPROC_SETACL 40 297 298/* 299 * Must be defined as one higher than the last Proc# above. 300 */ 301#define NFSV4_NPROCS 41 302 303/* 304 * Stats structure 305 */ 306struct ext_nfsstats { 307 int attrcache_hits; 308 int attrcache_misses; 309 int lookupcache_hits; 310 int lookupcache_misses; 311 int direofcache_hits; 312 int direofcache_misses; 313 int accesscache_hits; 314 int accesscache_misses; 315 int biocache_reads; 316 int read_bios; 317 int read_physios; 318 int biocache_writes; 319 int write_bios; 320 int write_physios; 321 int biocache_readlinks; 322 int readlink_bios; 323 int biocache_readdirs; 324 int readdir_bios; 325 int rpccnt[NFSV4_NPROCS]; 326 int rpcretries; 327 int srvrpccnt[NFSV4OP_NOPS + NFSV4OP_FAKENOPS]; 328 int srvrpc_errs; 329 int srv_errs; 330 int rpcrequests; 331 int rpctimeouts; 332 int rpcunexpected; 333 int rpcinvalid; 334 int srvcache_inproghits; 335 int srvcache_idemdonehits; 336 int srvcache_nonidemdonehits; 337 int srvcache_misses; 338 int srvcache_tcppeak; 339 int srvcache_size; 340 int srvclients; 341 int srvopenowners; 342 int srvopens; 343 int srvlockowners; 344 int srvlocks; 345 int srvdelegates; 346 int cbrpccnt[NFSV4OP_CBNOPS]; 347 int clopenowners; 348 int clopens; 349 int cllockowners; 350 int cllocks; 351 int cldelegates; 352 int cllocalopenowners; 353 int cllocalopens; 354 int cllocallockowners; 355 int cllocallocks; 356}; 357 358#ifdef _KERNEL 359/* 360 * Define the ext_nfsstats as nfsstats for the kernel code. 361 */ 362#define nfsstats ext_nfsstats 363 364/* 365 * Define NFS_NPROCS as NFSV4_NPROCS for the experimental kernel code. 366 */ 367#define NFS_NPROCS NFSV4_NPROCS 368 369#include <fs/nfs/nfskpiport.h> 370#include <fs/nfs/nfsdport.h> 371#include <fs/nfs/rpcv2.h> 372#include <fs/nfs/nfsproto.h> 373#include <fs/nfs/nfs.h> 374#include <fs/nfs/nfs_var.h> 375#include <fs/nfs/nfsm_subs.h> 376#include <fs/nfs/nfsrvcache.h> 377#include <fs/nfs/nfsrvstate.h> 378#include <fs/nfs/xdr_subs.h> 379#include <fs/nfs/nfscl.h> 380#include <fs/nfs/nfsclstate.h> 381#include <fs/nfsclient/nfsargs.h> 382#include <fs/nfsclient/nfsmount.h> 383 384/* 385 * Just to keep nfs_var.h happy. 386 */ 387struct nfs_vattr { 388 int junk; 389}; 390 391struct nfsvattr { 392 struct vattr na_vattr; 393 nfsattrbit_t na_suppattr; 394 u_int32_t na_mntonfileno; 395 u_int64_t na_filesid[2]; 396}; 397 398#define na_type na_vattr.va_type 399#define na_mode na_vattr.va_mode 400#define na_nlink na_vattr.va_nlink 401#define na_uid na_vattr.va_uid 402#define na_gid na_vattr.va_gid 403#define na_fsid na_vattr.va_fsid 404#define na_fileid na_vattr.va_fileid 405#define na_size na_vattr.va_size 406#define na_blocksize na_vattr.va_blocksize 407#define na_atime na_vattr.va_atime 408#define na_mtime na_vattr.va_mtime 409#define na_ctime na_vattr.va_ctime 410#define na_gen na_vattr.va_gen 411#define na_flags na_vattr.va_flags 412#define na_rdev na_vattr.va_rdev 413#define na_bytes na_vattr.va_bytes 414#define na_filerev na_vattr.va_filerev 415#define na_vaflags na_vattr.va_vaflags 416 417#include <fs/nfsclient/nfsnode.h> 418 419/* 420 * This is the header structure used for the lists, etc. (It has the 421 * above record in it. 422 */ 423struct nfsrv_stablefirst { 424 LIST_HEAD(, nfsrv_stable) nsf_head; /* Head of nfsrv_stable list */ 425 time_t nsf_eograce; /* Time grace period ends */ 426 time_t *nsf_bootvals; /* Previous boottime values */ 427 struct file *nsf_fp; /* File table pointer */ 428 u_char nsf_flags; /* NFSNSF_ flags */ 429 struct nfsf_rec nsf_rec; /* and above first record */ 430}; 431#define nsf_lease nsf_rec.lease 432#define nsf_numboots nsf_rec.numboots 433 434/* NFSNSF_xxx flags */ 435#define NFSNSF_UPDATEDONE 0x01 436#define NFSNSF_GRACEOVER 0x02 437#define NFSNSF_NEEDLOCK 0x04 438#define NFSNSF_EXPIREDCLIENT 0x08 439#define NFSNSF_NOOPENS 0x10 440#define NFSNSF_OK 0x20 441 442/* 443 * Maximum number of boot times allowed in record. Although there is 444 * really no need for a fixed upper bound, this serves as a sanity check 445 * for a corrupted file. 446 */ 447#define NFSNSF_MAXNUMBOOTS 10000 448 449/* 450 * This structure defines the other records in the file. The 451 * nst_client array is actually the size of the client string name. 452 */ 453struct nfst_rec { 454 u_int16_t len; 455 u_char flag; 456 u_char client[1]; 457}; 458/* and the values for flag */ 459#define NFSNST_NEWSTATE 0x1 460#define NFSNST_REVOKE 0x2 461#define NFSNST_GOTSTATE 0x4 462 463/* 464 * This structure is linked onto nfsrv_stablefirst for the duration of 465 * reclaim. 466 */ 467struct nfsrv_stable { 468 LIST_ENTRY(nfsrv_stable) nst_list; 469 struct nfsclient *nst_clp; 470 struct nfst_rec nst_rec; 471}; 472#define nst_timestamp nst_rec.timestamp 473#define nst_len nst_rec.len 474#define nst_flag nst_rec.flag 475#define nst_client nst_rec.client 476 477/* 478 * At some point the server will run out of kernel storage for 479 * state structures. For FreeBSD5.2, this results in a panic 480 * kmem_map is full. It happens at well over 1000000 opens plus 481 * locks on a PIII-800 with 256Mbytes, so that is where I've set 482 * the limit. If your server panics due to too many opens/locks, 483 * decrease the size of NFSRV_V4STATELIMIT. If you find the server 484 * returning NFS4ERR_RESOURCE a lot and have lots of memory, try 485 * increasing it. 486 */ 487#define NFSRV_V4STATELIMIT 500000 /* Max # of Opens + Locks */ 488 489/* 490 * The type required differs with BSDen (just the second arg). 491 */ 492void nfsrvd_rcv(struct socket *, void *, int); 493 494/* 495 * Macros for handling socket addresses. (Hopefully this makes the code 496 * more portable, since I've noticed some 'BSD don't have sockaddrs in 497 * mbufs any more.) 498 */ 499#define NFSSOCKADDR(a, t) ((t)(a)) 500#define NFSSOCKADDRALLOC(a) \ 501 do { \ 502 MALLOC((a), struct sockaddr *, sizeof (struct sockaddr), \ 503 M_SONAME, M_WAITOK); \ 504 NFSBZERO((a), sizeof (struct sockaddr)); \ 505 } while (0) 506#define NFSSOCKADDRSIZE(a, s) ((a)->sa_len = (s)) 507#define NFSSOCKADDRFREE(a) \ 508 do { \ 509 if (a) \ 510 FREE((caddr_t)(a), M_SONAME); \ 511 } while (0) 512 513/* 514 * These should be defined as a process or thread structure, as required 515 * for signal handling, etc. 516 */ 517#define NFSNEWCRED(c) (crdup(c)) 518#define NFSPROCCRED(p) ((p)->td_ucred) 519#define NFSFREECRED(c) (crfree(c)) 520#define NFSUIOPROC(u, p) ((u)->uio_td = NULL) 521#define NFSPROCP(p) ((p)->td_proc) 522 523/* 524 * Define these so that cn_hash and its length is ignored. 525 */ 526#define NFSCNHASHZERO(c) 527#define NFSCNHASH(c, v) 528#define NCHNAMLEN 9999999 529 530/* 531 * Define these to use the time of day clock. 532 */ 533#define NFSGETTIME(t) (getmicrotime(t)) 534#define NFSGETNANOTIME(t) (getnanotime(t)) 535 536/* 537 * These macros are defined to initialize and set the timer routine. 538 */ 539#define NFS_TIMERINIT \ 540 newnfs_timer(NULL) 541 542/* 543 * Handle SMP stuff: 544 */ 545#define NFSSTATESPINLOCK extern struct mtx nfs_state_mutex 546#define NFSLOCKSTATE() mtx_lock(&nfs_state_mutex) 547#define NFSUNLOCKSTATE() mtx_unlock(&nfs_state_mutex) 548#define NFSREQSPINLOCK extern struct mtx nfs_req_mutex 549#define NFSLOCKREQ() mtx_lock(&nfs_req_mutex) 550#define NFSUNLOCKREQ() mtx_unlock(&nfs_req_mutex) 551#define NFSCACHEMUTEX extern struct mtx nfs_cache_mutex 552#define NFSCACHEMUTEXPTR (&nfs_cache_mutex) 553#define NFSLOCKCACHE() mtx_lock(&nfs_cache_mutex) 554#define NFSUNLOCKCACHE() mtx_unlock(&nfs_cache_mutex) 555#define NFSCACHELOCKREQUIRED() mtx_assert(&nfs_cache_mutex, MA_OWNED) 556#define NFSSOCKMUTEX extern struct mtx nfs_slock_mutex 557#define NFSSOCKMUTEXPTR (&nfs_slock_mutex) 558#define NFSLOCKSOCK() mtx_lock(&nfs_slock_mutex) 559#define NFSUNLOCKSOCK() mtx_unlock(&nfs_slock_mutex) 560#define NFSNAMEIDMUTEX extern struct mtx nfs_nameid_mutex 561#define NFSLOCKNAMEID() mtx_lock(&nfs_nameid_mutex) 562#define NFSUNLOCKNAMEID() mtx_unlock(&nfs_nameid_mutex) 563#define NFSNAMEIDREQUIRED() mtx_assert(&nfs_nameid_mutex, MA_OWNED) 564#define NFSCLSTATEMUTEX extern struct mtx nfs_clstate_mutex 565#define NFSCLSTATEMUTEXPTR (&nfs_clstate_mutex) 566#define NFSLOCKCLSTATE() mtx_lock(&nfs_clstate_mutex) 567#define NFSUNLOCKCLSTATE() mtx_unlock(&nfs_clstate_mutex) 568#define NFSDLOCKMUTEX extern struct mtx newnfsd_mtx 569#define NFSDLOCKMUTEXPTR (&newnfsd_mtx) 570#define NFSD_LOCK() mtx_lock(&newnfsd_mtx) 571#define NFSD_UNLOCK() mtx_unlock(&newnfsd_mtx) 572#define NFSD_LOCK_ASSERT() mtx_assert(&newnfsd_mtx, MA_OWNED) 573#define NFSD_UNLOCK_ASSERT() mtx_assert(&newnfsd_mtx, MA_NOTOWNED) 574#define NFSV4ROOTLOCKMUTEX extern struct mtx nfs_v4root_mutex 575#define NFSV4ROOTLOCKMUTEXPTR (&nfs_v4root_mutex) 576#define NFSLOCKV4ROOTMUTEX() mtx_lock(&nfs_v4root_mutex) 577#define NFSUNLOCKV4ROOTMUTEX() mtx_unlock(&nfs_v4root_mutex) 578#define NFSLOCKNODE(n) mtx_lock(&((n)->n_mtx)) 579#define NFSUNLOCKNODE(n) mtx_unlock(&((n)->n_mtx)) 580#define NFSLOCKMNT(m) mtx_lock(&((m)->nm_mtx)) 581#define NFSUNLOCKMNT(m) mtx_unlock(&((m)->nm_mtx)) 582#define NFSLOCKREQUEST(r) mtx_lock(&((r)->r_mtx)) 583#define NFSUNLOCKREQUEST(r) mtx_unlock(&((r)->r_mtx)) 584#define NFSPROCLISTLOCK() sx_slock(&allproc_lock) 585#define NFSPROCLISTUNLOCK() sx_sunlock(&allproc_lock) 586#define NFSLOCKSOCKREQ(r) mtx_lock(&((r)->nr_mtx)) 587#define NFSUNLOCKSOCKREQ(r) mtx_unlock(&((r)->nr_mtx)) 588 589/* 590 * Use these macros to initialize/free a mutex. 591 */ 592#define NFSINITSOCKMUTEX(m) mtx_init((m), "nfssock", NULL, MTX_DEF) 593#define NFSFREEMUTEX(m) mtx_destroy((m)) 594 595int nfsmsleep(void *, void *, int, const char *, struct timespec *); 596 597/* 598 * And weird vm stuff in the nfs server. 599 */ 600#define PDIRUNLOCK 0x0 601#define MAX_COMMIT_COUNT (1024 * 1024) 602 603/* 604 * These macros are called at the start and end of operations that 605 * might modify the underlying file system. 606 */ 607#define NFS_STARTWRITE(v, m) vn_start_write((v), (m), V_WAIT) 608#define NFS_ENDWRITE(m) vn_finished_write(m) 609 610/* 611 * Define these to handle the type of va_rdev. 612 */ 613#define NFSMAKEDEV(m, n) makedev((m), (n)) 614#define NFSMAJOR(d) major(d) 615#define NFSMINOR(d) minor(d) 616 617/* 618 * Define this to be the macro that returns the minimum size required 619 * for a directory entry. 620 */ 621#define DIRENT_SIZE(dp) GENERIC_DIRSIZ(dp) 622 623/* 624 * The vnode tag for nfsv4root. 625 */ 626#define VT_NFSV4ROOT "nfsv4root" 627 628/* 629 * Define whatever it takes to do a vn_rdwr(). 630 */ 631#define NFSD_RDWR(r, v, b, l, o, s, i, c, a, p) \ 632 vn_rdwr((r), (v), (b), (l), (o), (s), (i), (c), NULL, (a), (p)) 633 634/* 635 * Macros for handling memory for different BSDen. 636 * NFSBCOPY(src, dst, len) - copies len bytes, non-overlapping 637 * NFSOVBCOPY(src, dst, len) - ditto, but data areas might overlap 638 * NFSBCMP(cp1, cp2, len) - compare len bytes, return 0 if same 639 * NFSBZERO(cp, len) - set len bytes to 0x0 640 */ 641#define NFSBCOPY(s, d, l) bcopy((s), (d), (l)) 642#define NFSOVBCOPY(s, d, l) ovbcopy((s), (d), (l)) 643#define NFSBCMP(s, d, l) bcmp((s), (d), (l)) 644#define NFSBZERO(s, l) bzero((s), (l)) 645 646/* 647 * Some queue.h files don't have these dfined in them. 648 */ 649#define LIST_END(head) NULL 650#define SLIST_END(head) NULL 651#define TAILQ_END(head) NULL 652 653/* 654 * This must be defined to be a global variable the increments once 655 * per second, but never stops or goes backwards, even when a "date" 656 * command changes the tod clock. It is used for delta times for 657 * leases, etc. 658 */ 659#define NFSD_MONOSEC time_uptime 660 661/* 662 * Declare the malloc types. 663 */ 664MALLOC_DECLARE(M_NEWNFSRVCACHE); 665MALLOC_DECLARE(M_NEWNFSDCLIENT); 666MALLOC_DECLARE(M_NEWNFSDSTATE); 667MALLOC_DECLARE(M_NEWNFSDLOCK); 668MALLOC_DECLARE(M_NEWNFSDLOCKFILE); 669MALLOC_DECLARE(M_NEWNFSSTRING); 670MALLOC_DECLARE(M_NEWNFSUSERGROUP); 671MALLOC_DECLARE(M_NEWNFSDREQ); 672MALLOC_DECLARE(M_NEWNFSFH); 673MALLOC_DECLARE(M_NEWNFSCLOWNER); 674MALLOC_DECLARE(M_NEWNFSCLOPEN); 675MALLOC_DECLARE(M_NEWNFSCLDELEG); 676MALLOC_DECLARE(M_NEWNFSCLCLIENT); 677MALLOC_DECLARE(M_NEWNFSCLLOCKOWNER); 678MALLOC_DECLARE(M_NEWNFSCLLOCK); 679MALLOC_DECLARE(M_NEWNFSDIROFF); 680MALLOC_DECLARE(M_NEWNFSV4NODE); 681MALLOC_DECLARE(M_NEWNFSDIRECTIO); 682MALLOC_DECLARE(M_NEWNFSMNT); 683#define M_NFSRVCACHE M_NEWNFSRVCACHE 684#define M_NFSDCLIENT M_NEWNFSDCLIENT 685#define M_NFSDSTATE M_NEWNFSDSTATE 686#define M_NFSDLOCK M_NEWNFSDLOCK 687#define M_NFSDLOCKFILE M_NEWNFSDLOCKFILE 688#define M_NFSSTRING M_NEWNFSSTRING 689#define M_NFSUSERGROUP M_NEWNFSUSERGROUP 690#define M_NFSDREQ M_NEWNFSDREQ 691#define M_NFSFH M_NEWNFSFH 692#define M_NFSCLOWNER M_NEWNFSCLOWNER 693#define M_NFSCLOPEN M_NEWNFSCLOPEN 694#define M_NFSCLDELEG M_NEWNFSCLDELEG 695#define M_NFSCLCLIENT M_NEWNFSCLCLIENT 696#define M_NFSCLLOCKOWNER M_NEWNFSCLLOCKOWNER 697#define M_NFSCLLOCK M_NEWNFSCLLOCK 698#define M_NFSDIROFF M_NEWNFSDIROFF 699#define M_NFSV4NODE M_NEWNFSV4NODE 700#define M_NFSDIRECTIO M_NEWNFSDIRECTIO 701 702#define NFSINT_SIGMASK(set) \ 703 (SIGISMEMBER(set, SIGINT) || SIGISMEMBER(set, SIGTERM) || \ 704 SIGISMEMBER(set, SIGHUP) || SIGISMEMBER(set, SIGKILL) || \ 705 SIGISMEMBER(set, SIGQUIT)) 706 707/* 708 * Convert a quota block count to byte count. 709 */ 710#define NFSQUOTABLKTOBYTE(q, b) (q) *= (b) 711 712/* 713 * Define this as the largest file size supported. (It should probably 714 * be available via a VFS_xxx Op, but it isn't. 715 */ 716#define NFSRV_MAXFILESIZE ((u_int64_t)0x800000000000) 717 718/* 719 * Set this macro to index() or strchr(), whichever is supported. 720 */ 721#define STRCHR(s, c) index((s), (c)) 722 723/* 724 * Set the n_time in the client write rpc, as required. 725 */ 726#define NFSWRITERPC_SETTIME(w, n, v4) \ 727 do { \ 728 if (w) { \ 729 (n)->n_mtime = (n)->n_vattr.na_vattr.va_mtime; \ 730 if (v4) \ 731 (n)->n_change = (n)->n_vattr.na_vattr.va_filerev; \ 732 } \ 733 } while (0) 734 735/* 736 * Fake value, just to make the client work. 737 */ 738#define NFS_LATTR_NOSHRINK 1 739 740/* 741 * Prototypes for functions where the arguments vary for different ports. 742 */ 743int nfscl_loadattrcache(struct vnode **, struct nfsvattr *, void *, void *, 744 int, int); 745void newnfs_realign(struct mbuf **); 746 747/* 748 * If the port runs on an SMP box that can enforce Atomic ops with low 749 * overheads, define these as atomic increments/decrements. If not, 750 * don't worry about it, since these are used for stats that can be 751 * "out by one" without disastrous consequences. 752 */ 753#define NFSINCRGLOBAL(a) ((a)++) 754 755/* 756 * Assorted funky stuff to make things work under Darwin8. 757 */ 758/* 759 * These macros checks for a field in vattr being set. 760 */ 761#define NFSATTRISSET(t, v, a) ((v)->a != (t)VNOVAL) 762#define NFSATTRISSETTIME(v, a) ((v)->a.tv_sec != VNOVAL) 763 764/* 765 * Manipulate mount flags. 766 */ 767#define NFSSTA_HASWRITEVERF 0x00040000 /* Has write verifier */ 768#define NFSSTA_GOTFSINFO 0x00100000 /* Got the fsinfo */ 769#define NFSSTA_TIMEO 0x10000000 /* Experiencing a timeout */ 770#define NFSSTA_LOCKTIMEO 0x20000000 /* Experiencing a lockd timeout */ 771#define NFSSTA_HASSETFSID 0x40000000 /* Has set the fsid */ 772 773#define NFSHASNFSV3(n) ((n)->nm_flag & NFSMNT_NFSV3) 774#define NFSHASNFSV4(n) ((n)->nm_flag & NFSMNT_NFSV4) 775#define NFSHASNFSV3OR4(n) ((n)->nm_flag & (NFSMNT_NFSV3 | NFSMNT_NFSV4)) 776#define NFSHASGOTFSINFO(n) ((n)->nm_state & NFSSTA_GOTFSINFO) 777#define NFSHASHASSETFSID(n) ((n)->nm_state & NFSSTA_HASSETFSID) 778#define NFSHASSTRICT3530(n) ((n)->nm_flag & NFSMNT_STRICT3530) 779#define NFSHASWRITEVERF(n) ((n)->nm_state & NFSSTA_HASWRITEVERF) 780#define NFSHASINT(n) ((n)->nm_flag & NFSMNT_INT) 781#define NFSHASSOFT(n) ((n)->nm_flag & NFSMNT_SOFT) 782#define NFSHASINTORSOFT(n) ((n)->nm_flag & (NFSMNT_INT | NFSMNT_SOFT)) 783#define NFSHASDUMBTIMR(n) ((n)->nm_flag & NFSMNT_DUMBTIMR) 784#define NFSHASNOCONN(n) ((n)->nm_flag & NFSMNT_MNTD) 785#define NFSHASKERB(n) ((n)->nm_flag & NFSMNT_KERB) 786#define NFSHASALLGSSNAME(n) ((n)->nm_flag & NFSMNT_ALLGSSNAME) 787#define NFSHASINTEGRITY(n) ((n)->nm_flag & NFSMNT_INTEGRITY) 788#define NFSHASPRIVACY(n) ((n)->nm_flag & NFSMNT_PRIVACY) 789#define NFSSETWRITEVERF(n) ((n)->nm_state |= NFSSTA_HASWRITEVERF) 790#define NFSSETHASSETFSID(n) ((n)->nm_state |= NFSSTA_HASSETFSID) 791#ifdef NFS4_ACL_EXTATTR_NAME 792#define NFSHASNFS4ACL(m) nfs_supportsnfsv4acls(m) 793int nfs_supportsnfsv4acls(struct mount *); 794#else 795#define NFSHASNFS4ACL(m) 0 796#endif 797 798/* 799 * Gets the stats field out of the mount structure. 800 */ 801#define vfs_statfs(m) (&((m)->mnt_stat)) 802 803/* 804 * Set boottime. 805 */ 806#define NFSSETBOOTTIME(b) ((b) = boottime) 807 808/* 809 * The size of directory blocks in the buffer cache. 810 * MUST BE in the range of PAGE_SIZE <= NFS_DIRBLKSIZ <= MAXBSIZE!! 811 */ 812#define NFS_DIRBLKSIZ (16 * DIRBLKSIZ) /* Must be a multiple of DIRBLKSIZ */ 813 814/* 815 * Define these macros to access mnt_flag fields. 816 */ 817#define NFSMNT_RDONLY(m) ((m)->mnt_flag & MNT_RDONLY) 818#endif /* _KERNEL */ 819 820/* 821 * Define a structure similar to ufs_args for use in exporting the V4 root. 822 */ 823struct nfsex_args { 824 char *fspec; 825 struct export_args export; 826}; 827 828/* 829 * These export flags should be defined, but there are no bits left. 830 * Maybe a separate mnt_exflag field could be added or the mnt_flag 831 * field increased to 64 bits? 832 */ 833#ifndef MNT_EXSTRICTACCESS 834#define MNT_EXSTRICTACCESS 0x0 835#endif 836#ifndef MNT_EXV4ONLY 837#define MNT_EXV4ONLY 0x0 838#endif 839 840#ifdef _KERNEL 841/* 842 * Define this to invalidate the attribute cache for the nfs node. 843 */ 844#define NFSINVALATTRCACHE(n) ((n)->n_attrstamp = 0) 845 846/* Used for FreeBSD only */ 847void nfsd_mntinit(void); 848 849/* 850 * Define these for vnode lock/unlock ops. 851 */ 852#define NFSVOPLOCK(v, f, p) vn_lock((v), (f)) 853#define NFSVOPUNLOCK(v, f, p) VOP_UNLOCK((v), (f)) 854#define NFSVOPISLOCKED(v, p) VOP_ISLOCKED((v)) 855 856/* 857 * Define ncl_hash(). 858 */ 859#define ncl_hash(f, l) (fnv_32_buf((f), (l), FNV1_32_INIT)) 860 861int newnfs_iosize(struct nfsmount *); 862 863#ifdef NFS_DEBUG 864 865extern int nfs_debug; 866#define NFS_DEBUG_ASYNCIO 1 /* asynchronous i/o */ 867#define NFS_DEBUG_WG 2 /* server write gathering */ 868#define NFS_DEBUG_RC 4 /* server request caching */ 869 870#define NFS_DPF(cat, args) \ 871 do { \ 872 if (nfs_debug & NFS_DEBUG_##cat) printf args; \ 873 } while (0) 874 875#else 876 877#define NFS_DPF(cat, args) 878 879#endif 880 881int newnfs_vncmpf(struct vnode *, void *); 882 883#ifndef NFS_MINDIRATTRTIMO 884#define NFS_MINDIRATTRTIMO 3 /* VDIR attrib cache timeout in sec */ 885#endif 886#ifndef NFS_MAXDIRATTRTIMO 887#define NFS_MAXDIRATTRTIMO 60 888#endif 889 890/* 891 * Nfs outstanding request list element 892 */ 893struct nfsreq { 894 TAILQ_ENTRY(nfsreq) r_chain; 895 u_int32_t r_flags; /* flags on request, see below */ 896 struct nfsmount *r_nmp; /* Client mnt ptr */ 897 struct mtx r_mtx; /* Mutex lock for this structure */ 898}; 899 900#ifndef NFS_MAXBSIZE 901#define NFS_MAXBSIZE MAXBSIZE 902#endif 903 904/* 905 * This macro checks to see if issuing of delegations is allowed for this 906 * vnode. 907 */ 908#ifdef VV_DISABLEDELEG 909#define NFSVNO_DELEGOK(v) \ 910 ((v) == NULL || ((v)->v_vflag & VV_DISABLEDELEG) == 0) 911#else 912#define NFSVNO_DELEGOK(v) (1) 913#endif 914 915#endif /* _KERNEL */ 916 917#endif /* _NFSPORT_NFS_H */ 918