sys/fs/nfs/nfsport.h

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