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