sys/fs/nfs/nfsport.h

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