sys/nfsclient/nfs_subs.c

   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  *      @(#)nfs_subs.c  8.8 (Berkeley) 5/22/95
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 /*
  39  * These functions support the macros and help fiddle mbuf chains for
  40  * the nfs op functions. They do things like create the rpc header and
  41  * copy data between mbuf chains and uio lists.
  42  */
  43
  44 #include "opt_kdtrace.h"
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/kernel.h>
  49 #include <sys/bio.h>
  50 #include <sys/buf.h>
  51 #include <sys/proc.h>
  52 #include <sys/mount.h>
  53 #include <sys/vnode.h>
  54 #include <sys/namei.h>
  55 #include <sys/mbuf.h>
  56 #include <sys/socket.h>
  57 #include <sys/stat.h>
  58 #include <sys/malloc.h>
  59 #include <sys/sysent.h>
  60 #include <sys/syscall.h>
  61 #include <sys/sysproto.h>
  62 #include <sys/taskqueue.h>
  63
  64 #include <vm/vm.h>
  65 #include <vm/vm_object.h>
  66 #include <vm/vm_extern.h>
  67 #include <vm/uma.h>
  68
  69 #include <nfs/nfsproto.h>
  70 #include <nfsclient/nfs.h>
  71 #include <nfsclient/nfsnode.h>
  72 #include <nfsclient/nfs_kdtrace.h>
  73 #include <nfs/xdr_subs.h>
  74 #include <nfsclient/nfsm_subs.h>
  75 #include <nfsclient/nfsmount.h>
  76
  77 #include <netinet/in.h>
  78
  79 /*
  80  * Note that stdarg.h and the ANSI style va_start macro is used for both
  81  * ANSI and traditional C compilers.
  82  */
  83 #include <machine/stdarg.h>
  84
  85 #ifdef KDTRACE_HOOKS
  86 dtrace_nfsclient_attrcache_flush_probe_func_t
  87     dtrace_nfsclient_attrcache_flush_done_probe;
  88 uint32_t nfsclient_attrcache_flush_done_id;
  89
  90 dtrace_nfsclient_attrcache_get_hit_probe_func_t
  91     dtrace_nfsclient_attrcache_get_hit_probe;
  92 uint32_t nfsclient_attrcache_get_hit_id;
  93
  94 dtrace_nfsclient_attrcache_get_miss_probe_func_t
  95     dtrace_nfsclient_attrcache_get_miss_probe;
  96 uint32_t nfsclient_attrcache_get_miss_id;
  97
  98 dtrace_nfsclient_attrcache_load_probe_func_t
  99     dtrace_nfsclient_attrcache_load_done_probe;
 100 uint32_t nfsclient_attrcache_load_done_id;
 101 #endif /* !KDTRACE_HOOKS */
 102
 103 /*
 104  * Data items converted to xdr at startup, since they are constant
 105  * This is kinda hokey, but may save a little time doing byte swaps
 106  */
 107 u_int32_t       nfs_xdrneg1;
 108 u_int32_t       nfs_true, nfs_false;
 109
 110 /* And other global data */
 111 static u_int32_t nfs_xid = 0;
 112 static enum vtype nv2tov_type[8]= {
 113         VNON, VREG, VDIR, VBLK, VCHR, VLNK, VNON,  VNON
 114 };
 115
 116 int             nfs_ticks;
 117 int             nfs_pbuf_freecnt = -1;  /* start out unlimited */
 118
 119 struct nfs_bufq nfs_bufq;
 120 static struct mtx nfs_xid_mtx;
 121 struct task     nfs_nfsiodnew_task;
 122
 123 /*
 124  * and the reverse mapping from generic to Version 2 procedure numbers
 125  */
 126 int nfsv2_procid[NFS_NPROCS] = {
 127         NFSV2PROC_NULL,
 128         NFSV2PROC_GETATTR,
 129         NFSV2PROC_SETATTR,
 130         NFSV2PROC_LOOKUP,
 131         NFSV2PROC_NOOP,
 132         NFSV2PROC_READLINK,
 133         NFSV2PROC_READ,
 134         NFSV2PROC_WRITE,
 135         NFSV2PROC_CREATE,
 136         NFSV2PROC_MKDIR,
 137         NFSV2PROC_SYMLINK,
 138         NFSV2PROC_CREATE,
 139         NFSV2PROC_REMOVE,
 140         NFSV2PROC_RMDIR,
 141         NFSV2PROC_RENAME,
 142         NFSV2PROC_LINK,
 143         NFSV2PROC_READDIR,
 144         NFSV2PROC_NOOP,
 145         NFSV2PROC_STATFS,
 146         NFSV2PROC_NOOP,
 147         NFSV2PROC_NOOP,
 148         NFSV2PROC_NOOP,
 149         NFSV2PROC_NOOP,
 150 };
 151
 152 LIST_HEAD(nfsnodehashhead, nfsnode);
 153
 154 u_int32_t
 155 nfs_xid_gen(void)
 156 {
 157         uint32_t xid;
 158
 159         mtx_lock(&nfs_xid_mtx);
 160
 161         /* Get a pretty random xid to start with */
 162         if (!nfs_xid)
 163                 nfs_xid = random();
 164         /*
 165          * Skip zero xid if it should ever happen.
 166          */
 167         if (++nfs_xid == 0)
 168                 nfs_xid++;
 169         xid = nfs_xid;
 170         mtx_unlock(&nfs_xid_mtx);
 171         return xid;
 172 }
 173
 174 /*
 175  * Create the header for an rpc request packet
 176  * The hsiz is the size of the rest of the nfs request header.
 177  * (just used to decide if a cluster is a good idea)
 178  */
 179 struct mbuf *
 180 nfsm_reqhead(struct vnode *vp, u_long procid, int hsiz)
 181 {
 182         struct mbuf *mb;
 183
 184         MGET(mb, M_WAIT, MT_DATA);
 185         if (hsiz >= MINCLSIZE)
 186                 MCLGET(mb, M_WAIT);
 187         mb->m_len = 0;
 188         return (mb);
 189 }
 190
 191 /*
 192  * copies a uio scatter/gather list to an mbuf chain.
 193  * NOTE: can ony handle iovcnt == 1
 194  */
 195 int
 196 nfsm_uiotombuf(struct uio *uiop, struct mbuf **mq, int siz, caddr_t *bpos)
 197 {
 198         char *uiocp;
 199         struct mbuf *mp, *mp2;
 200         int xfer, left, mlen;
 201         int uiosiz, clflg, rem;
 202         char *cp;
 203
 204         KASSERT(uiop->uio_iovcnt == 1, ("nfsm_uiotombuf: iovcnt != 1"));
 205
 206         if (siz > MLEN)         /* or should it >= MCLBYTES ?? */
 207                 clflg = 1;
 208         else
 209                 clflg = 0;
 210         rem = nfsm_rndup(siz)-siz;
 211         mp = mp2 = *mq;
 212         while (siz > 0) {
 213                 left = uiop->uio_iov->iov_len;
 214                 uiocp = uiop->uio_iov->iov_base;
 215                 if (left > siz)
 216                         left = siz;
 217                 uiosiz = left;
 218                 while (left > 0) {
 219                         mlen = M_TRAILINGSPACE(mp);
 220                         if (mlen == 0) {
 221                                 MGET(mp, M_WAIT, MT_DATA);
 222                                 if (clflg)
 223                                         MCLGET(mp, M_WAIT);
 224                                 mp->m_len = 0;
 225                                 mp2->m_next = mp;
 226                                 mp2 = mp;
 227                                 mlen = M_TRAILINGSPACE(mp);
 228                         }
 229                         xfer = (left > mlen) ? mlen : left;
 230 #ifdef notdef
 231                         /* Not Yet.. */
 232                         if (uiop->uio_iov->iov_op != NULL)
 233                                 (*(uiop->uio_iov->iov_op))
 234                                 (uiocp, mtod(mp, caddr_t)+mp->m_len, xfer);
 235                         else
 236 #endif
 237                         if (uiop->uio_segflg == UIO_SYSSPACE)
 238                                 bcopy(uiocp, mtod(mp, caddr_t)+mp->m_len, xfer);
 239                         else
 240                                 copyin(uiocp, mtod(mp, caddr_t)+mp->m_len, xfer);
 241                         mp->m_len += xfer;
 242                         left -= xfer;
 243                         uiocp += xfer;
 244                         uiop->uio_offset += xfer;
 245                         uiop->uio_resid -= xfer;
 246                 }
 247                 uiop->uio_iov->iov_base =
 248                     (char *)uiop->uio_iov->iov_base + uiosiz;
 249                 uiop->uio_iov->iov_len -= uiosiz;
 250                 siz -= uiosiz;
 251         }
 252         if (rem > 0) {
 253                 if (rem > M_TRAILINGSPACE(mp)) {
 254                         MGET(mp, M_WAIT, MT_DATA);
 255                         mp->m_len = 0;
 256                         mp2->m_next = mp;
 257                 }
 258                 cp = mtod(mp, caddr_t)+mp->m_len;
 259                 for (left = 0; left < rem; left++)
 260                         *cp++ = '\0';
 261                 mp->m_len += rem;
 262                 *bpos = cp;
 263         } else
 264                 *bpos = mtod(mp, caddr_t)+mp->m_len;
 265         *mq = mp;
 266         return (0);
 267 }
 268
 269 /*
 270  * Copy a string into mbufs for the hard cases...
 271  */
 272 int
 273 nfsm_strtmbuf(struct mbuf **mb, char **bpos, const char *cp, long siz)
 274 {
 275         struct mbuf *m1 = NULL, *m2;
 276         long left, xfer, len, tlen;
 277         u_int32_t *tl;
 278         int putsize;
 279
 280         putsize = 1;
 281         m2 = *mb;
 282         left = M_TRAILINGSPACE(m2);
 283         if (left > 0) {
 284                 tl = ((u_int32_t *)(*bpos));
 285                 *tl++ = txdr_unsigned(siz);
 286                 putsize = 0;
 287                 left -= NFSX_UNSIGNED;
 288                 m2->m_len += NFSX_UNSIGNED;
 289                 if (left > 0) {
 290                         bcopy(cp, (caddr_t) tl, left);
 291                         siz -= left;
 292                         cp += left;
 293                         m2->m_len += left;
 294                         left = 0;
 295                 }
 296         }
 297         /* Loop around adding mbufs */
 298         while (siz > 0) {
 299                 MGET(m1, M_WAIT, MT_DATA);
 300                 if (siz > MLEN)
 301                         MCLGET(m1, M_WAIT);
 302                 m1->m_len = NFSMSIZ(m1);
 303                 m2->m_next = m1;
 304                 m2 = m1;
 305                 tl = mtod(m1, u_int32_t *);
 306                 tlen = 0;
 307                 if (putsize) {
 308                         *tl++ = txdr_unsigned(siz);
 309                         m1->m_len -= NFSX_UNSIGNED;
 310                         tlen = NFSX_UNSIGNED;
 311                         putsize = 0;
 312                 }
 313                 if (siz < m1->m_len) {
 314                         len = nfsm_rndup(siz);
 315                         xfer = siz;
 316                         if (xfer < len)
 317                                 *(tl+(xfer>>2)) = 0;
 318                 } else {
 319                         xfer = len = m1->m_len;
 320                 }
 321                 bcopy(cp, (caddr_t) tl, xfer);
 322                 m1->m_len = len+tlen;
 323                 siz -= xfer;
 324                 cp += xfer;
 325         }
 326         *mb = m1;
 327         *bpos = mtod(m1, caddr_t)+m1->m_len;
 328         return (0);
 329 }
 330
 331 /*
 332  * Called once to initialize data structures...
 333  */
 334 int
 335 nfs_init(struct vfsconf *vfsp)
 336 {
 337         int i;
 338
 339         nfsmount_zone = uma_zcreate("NFSMOUNT", sizeof(struct nfsmount),
 340             NULL, NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
 341         nfs_true = txdr_unsigned(TRUE);
 342         nfs_false = txdr_unsigned(FALSE);
 343         nfs_xdrneg1 = txdr_unsigned(-1);
 344         nfs_ticks = (hz * NFS_TICKINTVL + 500) / 1000;
 345         if (nfs_ticks < 1)
 346                 nfs_ticks = 1;
 347         /* Ensure async daemons disabled */
 348         for (i = 0; i < NFS_MAXASYNCDAEMON; i++) {
 349                 nfs_iodwant[i] = NFSIOD_NOT_AVAILABLE;
 350                 nfs_iodmount[i] = NULL;
 351         }
 352         nfs_nhinit();                   /* Init the nfsnode table */
 353
 354         /*
 355          * Initialize reply list and start timer
 356          */
 357         mtx_init(&nfs_iod_mtx, "NFS iod lock", NULL, MTX_DEF);
 358         mtx_init(&nfs_xid_mtx, "NFS xid lock", NULL, MTX_DEF);
 359         TASK_INIT(&nfs_nfsiodnew_task, 0, nfs_nfsiodnew_tq, NULL);
 360
 361         nfs_pbuf_freecnt = nswbuf / 2 + 1;
 362
 363         return (0);
 364 }
 365
 366 int
 367 nfs_uninit(struct vfsconf *vfsp)
 368 {
 369         int i;
 370
 371         /*
 372          * Tell all nfsiod processes to exit. Clear nfs_iodmax, and wakeup
 373          * any sleeping nfsiods so they check nfs_iodmax and exit.
 374          * Drain nfsiodnew task before we wait for them to finish.
 375          */
 376         mtx_lock(&nfs_iod_mtx);
 377         nfs_iodmax = 0;
 378         mtx_unlock(&nfs_iod_mtx);
 379         taskqueue_drain(taskqueue_thread, &nfs_nfsiodnew_task);
 380         mtx_lock(&nfs_iod_mtx);
 381         for (i = 0; i < nfs_numasync; i++)
 382                 if (nfs_iodwant[i] == NFSIOD_AVAILABLE)
 383                         wakeup(&nfs_iodwant[i]);
 384         /* The last nfsiod to exit will wake us up when nfs_numasync hits 0 */
 385         while (nfs_numasync)
 386                 msleep(&nfs_numasync, &nfs_iod_mtx, PWAIT, "ioddie", 0);
 387         mtx_unlock(&nfs_iod_mtx);
 388         nfs_nhuninit();
 389         uma_zdestroy(nfsmount_zone);
 390         return (0);
 391 }
 392
 393 void
 394 nfs_dircookie_lock(struct nfsnode *np)
 395 {
 396         mtx_lock(&np->n_mtx);
 397         while (np->n_flag & NDIRCOOKIELK)
 398                 (void) msleep(&np->n_flag, &np->n_mtx, PZERO, "nfsdirlk", 0);
 399         np->n_flag |= NDIRCOOKIELK;
 400         mtx_unlock(&np->n_mtx);
 401 }
 402
 403 void
 404 nfs_dircookie_unlock(struct nfsnode *np)
 405 {
 406         mtx_lock(&np->n_mtx);
 407         np->n_flag &= ~NDIRCOOKIELK;
 408         wakeup(&np->n_flag);
 409         mtx_unlock(&np->n_mtx);
 410 }
 411
 412 int
 413 nfs_upgrade_vnlock(struct vnode *vp)
 414 {
 415         int old_lock;
 416
 417         ASSERT_VOP_LOCKED(vp, "nfs_upgrade_vnlock");
 418         old_lock = VOP_ISLOCKED(vp);
 419         if (old_lock != LK_EXCLUSIVE) {
 420                 KASSERT(old_lock == LK_SHARED,
 421                     ("nfs_upgrade_vnlock: wrong old_lock %d", old_lock));
 422                 /* Upgrade to exclusive lock, this might block */
 423                 vn_lock(vp, LK_UPGRADE | LK_RETRY);
 424         }
 425         return (old_lock);
 426 }
 427
 428 void
 429 nfs_downgrade_vnlock(struct vnode *vp, int old_lock)
 430 {
 431         if (old_lock != LK_EXCLUSIVE) {
 432                 KASSERT(old_lock == LK_SHARED, ("wrong old_lock %d", old_lock));
 433                 /* Downgrade from exclusive lock. */
 434                 vn_lock(vp, LK_DOWNGRADE | LK_RETRY);
 435         }
 436 }
 437
 438 void
 439 nfs_printf(const char *fmt, ...)
 440 {
 441         va_list ap;
 442
 443         mtx_lock(&Giant);
 444         va_start(ap, fmt);
 445         printf(fmt, ap);
 446         va_end(ap);
 447         mtx_unlock(&Giant);
 448 }
 449
 450 /*
 451  * Attribute cache routines.
 452  * nfs_loadattrcache() - loads or updates the cache contents from attributes
 453  *      that are on the mbuf list
 454  * nfs_getattrcache() - returns valid attributes if found in cache, returns
 455  *      error otherwise
 456  */
 457
 458 /*
 459  * Load the attribute cache (that lives in the nfsnode entry) with
 460  * the values on the mbuf list and
 461  * Iff vap not NULL
 462  *    copy the attributes to *vaper
 463  */
 464 int
 465 nfs_loadattrcache(struct vnode **vpp, struct mbuf **mdp, caddr_t *dposp,
 466                   struct vattr *vaper, int dontshrink)
 467 {
 468         struct vnode *vp = *vpp;
 469         struct vattr *vap;
 470         struct nfs_fattr *fp;
 471         struct nfsnode *np = NULL;
 472         int32_t t1;
 473         caddr_t cp2;
 474         int rdev;
 475         struct mbuf *md;
 476         enum vtype vtyp;
 477         u_short vmode;
 478         struct timespec mtime, mtime_save;
 479         int v3 = NFS_ISV3(vp);
 480         int error = 0;
 481
 482         md = *mdp;
 483         t1 = (mtod(md, caddr_t) + md->m_len) - *dposp;
 484         cp2 = nfsm_disct(mdp, dposp, NFSX_FATTR(v3), t1, M_WAIT);
 485         if (cp2 == NULL) {
 486                 error = EBADRPC;
 487                 goto out;
 488         }
 489         fp = (struct nfs_fattr *)cp2;
 490         if (v3) {
 491                 vtyp = nfsv3tov_type(fp->fa_type);
 492                 vmode = fxdr_unsigned(u_short, fp->fa_mode);
 493                 rdev = makedev(fxdr_unsigned(int, fp->fa3_rdev.specdata1),
 494                         fxdr_unsigned(int, fp->fa3_rdev.specdata2));
 495                 fxdr_nfsv3time(&fp->fa3_mtime, &mtime);
 496         } else {
 497                 vtyp = nfsv2tov_type(fp->fa_type);
 498                 vmode = fxdr_unsigned(u_short, fp->fa_mode);
 499                 /*
 500                  * XXX
 501                  *
 502                  * The duplicate information returned in fa_type and fa_mode
 503                  * is an ambiguity in the NFS version 2 protocol.
 504                  *
 505                  * VREG should be taken literally as a regular file.  If a
 506                  * server intents to return some type information differently
 507                  * in the upper bits of the mode field (e.g. for sockets, or
 508                  * FIFOs), NFSv2 mandates fa_type to be VNON.  Anyway, we
 509                  * leave the examination of the mode bits even in the VREG
 510                  * case to avoid breakage for bogus servers, but we make sure
 511                  * that there are actually type bits set in the upper part of
 512                  * fa_mode (and failing that, trust the va_type field).
 513                  *
 514                  * NFSv3 cleared the issue, and requires fa_mode to not
 515                  * contain any type information (while also introduing sockets
 516                  * and FIFOs for fa_type).
 517                  */
 518                 if (vtyp == VNON || (vtyp == VREG && (vmode & S_IFMT) != 0))
 519                         vtyp = IFTOVT(vmode);
 520                 rdev = fxdr_unsigned(int32_t, fp->fa2_rdev);
 521                 fxdr_nfsv2time(&fp->fa2_mtime, &mtime);
 522
 523                 /*
 524                  * Really ugly NFSv2 kludge.
 525                  */
 526                 if (vtyp == VCHR && rdev == 0xffffffff)
 527                         vtyp = VFIFO;
 528         }
 529
 530         /*
 531          * If v_type == VNON it is a new node, so fill in the v_type,
 532          * n_mtime fields. Check to see if it represents a special
 533          * device, and if so, check for a possible alias. Once the
 534          * correct vnode has been obtained, fill in the rest of the
 535          * information.
 536          */
 537         np = VTONFS(vp);
 538         mtx_lock(&np->n_mtx);
 539         if (vp->v_type != vtyp) {
 540                 vp->v_type = vtyp;
 541                 if (vp->v_type == VFIFO)
 542                         vp->v_op = &nfs_fifoops;
 543                 np->n_mtime = mtime;
 544         }
 545         vap = &np->n_vattr;
 546         vap->va_type = vtyp;
 547         vap->va_mode = (vmode & 07777);
 548         vap->va_rdev = rdev;
 549         mtime_save = vap->va_mtime;
 550         vap->va_mtime = mtime;
 551         vap->va_fsid = vp->v_mount->mnt_stat.f_fsid.val[0];
 552         if (v3) {
 553                 vap->va_nlink = fxdr_unsigned(u_short, fp->fa_nlink);
 554                 vap->va_uid = fxdr_unsigned(uid_t, fp->fa_uid);
 555                 vap->va_gid = fxdr_unsigned(gid_t, fp->fa_gid);
 556                 vap->va_size = fxdr_hyper(&fp->fa3_size);
 557                 vap->va_blocksize = NFS_FABLKSIZE;
 558                 vap->va_bytes = fxdr_hyper(&fp->fa3_used);
 559                 vap->va_fileid = fxdr_unsigned(int32_t,
 560                     fp->fa3_fileid.nfsuquad[1]);
 561                 fxdr_nfsv3time(&fp->fa3_atime, &vap->va_atime);
 562                 fxdr_nfsv3time(&fp->fa3_ctime, &vap->va_ctime);
 563                 vap->va_flags = 0;
 564                 vap->va_filerev = 0;
 565         } else {
 566                 vap->va_nlink = fxdr_unsigned(u_short, fp->fa_nlink);
 567                 vap->va_uid = fxdr_unsigned(uid_t, fp->fa_uid);
 568                 vap->va_gid = fxdr_unsigned(gid_t, fp->fa_gid);
 569                 vap->va_size = fxdr_unsigned(u_int32_t, fp->fa2_size);
 570                 vap->va_blocksize = fxdr_unsigned(int32_t, fp->fa2_blocksize);
 571                 vap->va_bytes = (u_quad_t)fxdr_unsigned(int32_t, fp->fa2_blocks)
 572                     * NFS_FABLKSIZE;
 573                 vap->va_fileid = fxdr_unsigned(int32_t, fp->fa2_fileid);
 574                 fxdr_nfsv2time(&fp->fa2_atime, &vap->va_atime);
 575                 vap->va_flags = 0;
 576                 vap->va_ctime.tv_sec = fxdr_unsigned(u_int32_t,
 577                     fp->fa2_ctime.nfsv2_sec);
 578                 vap->va_ctime.tv_nsec = 0;
 579                 vap->va_gen = fxdr_unsigned(u_int32_t, fp->fa2_ctime.nfsv2_usec);
 580                 vap->va_filerev = 0;
 581         }
 582         np->n_attrstamp = time_second;
 583         if (vap->va_size != np->n_size) {
 584                 if (vap->va_type == VREG) {
 585                         if (dontshrink && vap->va_size < np->n_size) {
 586                                 /*
 587                                  * We've been told not to shrink the file;
 588                                  * zero np->n_attrstamp to indicate that
 589                                  * the attributes are stale.
 590                                  */
 591                                 vap->va_size = np->n_size;
 592                                 np->n_attrstamp = 0;
 593                                 KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
 594                         } else if (np->n_flag & NMODIFIED) {
 595                                 /*
 596                                  * We've modified the file: Use the larger
 597                                  * of our size, and the server's size.
 598                                  */
 599                                 if (vap->va_size < np->n_size) {
 600                                         vap->va_size = np->n_size;
 601                                 } else {
 602                                         np->n_size = vap->va_size;
 603                                         np->n_flag |= NSIZECHANGED;
 604                                 }
 605                         } else {
 606                                 np->n_size = vap->va_size;
 607                                 np->n_flag |= NSIZECHANGED;
 608                         }
 609                         vnode_pager_setsize(vp, np->n_size);
 610                 } else {
 611                         np->n_size = vap->va_size;
 612                 }
 613         }
 614         /*
 615          * The following checks are added to prevent a race between (say)
 616          * a READDIR+ and a WRITE.
 617          * READDIR+, WRITE requests sent out.
 618          * READDIR+ resp, WRITE resp received on client.
 619          * However, the WRITE resp was handled before the READDIR+ resp
 620          * causing the post op attrs from the write to be loaded first
 621          * and the attrs from the READDIR+ to be loaded later. If this
 622          * happens, we have stale attrs loaded into the attrcache.
 623          * We detect this by for the mtime moving back. We invalidate the
 624          * attrcache when this happens.
 625          */
 626         if (timespeccmp(&mtime_save, &vap->va_mtime, >)) {
 627                 /* Size changed or mtime went backwards */
 628                 np->n_attrstamp = 0;
 629                 KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
 630         }
 631         if (vaper != NULL) {
 632                 bcopy((caddr_t)vap, (caddr_t)vaper, sizeof(*vap));
 633                 if (np->n_flag & NCHG) {
 634                         if (np->n_flag & NACC)
 635                                 vaper->va_atime = np->n_atim;
 636                         if (np->n_flag & NUPD)
 637                                 vaper->va_mtime = np->n_mtim;
 638                 }
 639         }
 640
 641 #ifdef KDTRACE_HOOKS
 642         if (np->n_attrstamp != 0)
 643                 KDTRACE_NFS_ATTRCACHE_LOAD_DONE(vp, &np->n_vattr, 0);
 644 #endif
 645         mtx_unlock(&np->n_mtx);
 646 out:
 647 #ifdef KDTRACE_HOOKS
 648         if (error)
 649                 KDTRACE_NFS_ATTRCACHE_LOAD_DONE(vp, NULL, error);
 650 #endif
 651         return (error);
 652 }
 653
 654 #ifdef NFS_ACDEBUG
 655 #include <sys/sysctl.h>
 656 SYSCTL_DECL(_vfs_nfs);
 657 static int nfs_acdebug;
 658 SYSCTL_INT(_vfs_nfs, OID_AUTO, acdebug, CTLFLAG_RW, &nfs_acdebug, 0,
 659     "Toggle acdebug (access cache debug) flag");
 660 #endif
 661
 662 /*
 663  * Check the time stamp
 664  * If the cache is valid, copy contents to *vap and return 0
 665  * otherwise return an error
 666  */
 667 int
 668 nfs_getattrcache(struct vnode *vp, struct vattr *vaper)
 669 {
 670         struct nfsnode *np;
 671         struct vattr *vap;
 672         struct nfsmount *nmp;
 673         int timeo;
 674
 675         np = VTONFS(vp);
 676         vap = &np->n_vattr;
 677         nmp = VFSTONFS(vp->v_mount);
 678 #ifdef NFS_ACDEBUG
 679         mtx_lock(&Giant);       /* nfs_printf() */
 680 #endif
 681         mtx_lock(&np->n_mtx);
 682         /* XXX n_mtime doesn't seem to be updated on a miss-and-reload */
 683         timeo = (time_second - np->n_mtime.tv_sec) / 10;
 684
 685 #ifdef NFS_ACDEBUG
 686         if (nfs_acdebug>1)
 687                 nfs_printf("nfs_getattrcache: initial timeo = %d\n", timeo);
 688 #endif
 689
 690         if (vap->va_type == VDIR) {
 691                 if ((np->n_flag & NMODIFIED) || timeo < nmp->nm_acdirmin)
 692                         timeo = nmp->nm_acdirmin;
 693                 else if (timeo > nmp->nm_acdirmax)
 694                         timeo = nmp->nm_acdirmax;
 695         } else {
 696                 if ((np->n_flag & NMODIFIED) || timeo < nmp->nm_acregmin)
 697                         timeo = nmp->nm_acregmin;
 698                 else if (timeo > nmp->nm_acregmax)
 699                         timeo = nmp->nm_acregmax;
 700         }
 701
 702 #ifdef NFS_ACDEBUG
 703         if (nfs_acdebug > 2)
 704                 nfs_printf("acregmin %d; acregmax %d; acdirmin %d; acdirmax %d\n",
 705                            nmp->nm_acregmin, nmp->nm_acregmax,
 706                            nmp->nm_acdirmin, nmp->nm_acdirmax);
 707
 708         if (nfs_acdebug)
 709                 nfs_printf("nfs_getattrcache: age = %d; final timeo = %d\n",
 710                            (time_second - np->n_attrstamp), timeo);
 711 #endif
 712
 713         if ((time_second - np->n_attrstamp) >= timeo) {
 714                 nfsstats.attrcache_misses++;
 715                 mtx_unlock(&np->n_mtx);
 716                 KDTRACE_NFS_ATTRCACHE_GET_MISS(vp);
 717                 return (ENOENT);
 718         }
 719         nfsstats.attrcache_hits++;
 720         if (vap->va_size != np->n_size) {
 721                 if (vap->va_type == VREG) {
 722                         if (np->n_flag & NMODIFIED) {
 723                                 if (vap->va_size < np->n_size)
 724                                         vap->va_size = np->n_size;
 725                                 else
 726                                         np->n_size = vap->va_size;
 727                         } else {
 728                                 np->n_size = vap->va_size;
 729                         }
 730                         vnode_pager_setsize(vp, np->n_size);
 731                 } else {
 732                         np->n_size = vap->va_size;
 733                 }
 734         }
 735         bcopy((caddr_t)vap, (caddr_t)vaper, sizeof(struct vattr));
 736         if (np->n_flag & NCHG) {
 737                 if (np->n_flag & NACC)
 738                         vaper->va_atime = np->n_atim;
 739                 if (np->n_flag & NUPD)
 740                         vaper->va_mtime = np->n_mtim;
 741         }
 742         mtx_unlock(&np->n_mtx);
 743 #ifdef NFS_ACDEBUG
 744         mtx_unlock(&Giant);     /* nfs_printf() */
 745 #endif
 746         KDTRACE_NFS_ATTRCACHE_GET_HIT(vp, vap);
 747         return (0);
 748 }
 749
 750 /*
 751  * Purge all cached information about an NFS vnode including name
 752  * cache entries, the attribute cache, and the access cache.  This is
 753  * called when an NFS request for a node fails with a stale
 754  * filehandle.
 755  */
 756 void
 757 nfs_purgecache(struct vnode *vp)
 758 {
 759         struct nfsnode *np;
 760         int i;
 761
 762         np = VTONFS(vp);
 763         cache_purge(vp);
 764         mtx_lock(&np->n_mtx);
 765         np->n_attrstamp = 0;
 766         KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
 767         for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
 768                 np->n_accesscache[i].stamp = 0;
 769         KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
 770         mtx_unlock(&np->n_mtx);
 771 }
 772
 773 static nfsuint64 nfs_nullcookie = { { 0, 0 } };
 774 /*
 775  * This function finds the directory cookie that corresponds to the
 776  * logical byte offset given.
 777  */
 778 nfsuint64 *
 779 nfs_getcookie(struct nfsnode *np, off_t off, int add)
 780 {
 781         struct nfsdmap *dp, *dp2;
 782         int pos;
 783         nfsuint64 *retval = NULL;
 784
 785         pos = (uoff_t)off / NFS_DIRBLKSIZ;
 786         if (pos == 0 || off < 0) {
 787                 KASSERT(!add, ("nfs getcookie add at <= 0"));
 788                 return (&nfs_nullcookie);
 789         }
 790         pos--;
 791         dp = LIST_FIRST(&np->n_cookies);
 792         if (!dp) {
 793                 if (add) {
 794                         dp = malloc(sizeof (struct nfsdmap),
 795                                 M_NFSDIROFF, M_WAITOK);
 796                         dp->ndm_eocookie = 0;
 797                         LIST_INSERT_HEAD(&np->n_cookies, dp, ndm_list);
 798                 } else
 799                         goto out;
 800         }
 801         while (pos >= NFSNUMCOOKIES) {
 802                 pos -= NFSNUMCOOKIES;
 803                 if (LIST_NEXT(dp, ndm_list)) {
 804                         if (!add && dp->ndm_eocookie < NFSNUMCOOKIES &&
 805                             pos >= dp->ndm_eocookie)
 806                                 goto out;
 807                         dp = LIST_NEXT(dp, ndm_list);
 808                 } else if (add) {
 809                         dp2 = malloc(sizeof (struct nfsdmap),
 810                                 M_NFSDIROFF, M_WAITOK);
 811                         dp2->ndm_eocookie = 0;
 812                         LIST_INSERT_AFTER(dp, dp2, ndm_list);
 813                         dp = dp2;
 814                 } else
 815                         goto out;
 816         }
 817         if (pos >= dp->ndm_eocookie) {
 818                 if (add)
 819                         dp->ndm_eocookie = pos + 1;
 820                 else
 821                         goto out;
 822         }
 823         retval = &dp->ndm_cookies[pos];
 824 out:
 825         return (retval);
 826 }
 827
 828 /*
 829  * Invalidate cached directory information, except for the actual directory
 830  * blocks (which are invalidated separately).
 831  * Done mainly to avoid the use of stale offset cookies.
 832  */
 833 void
 834 nfs_invaldir(struct vnode *vp)
 835 {
 836         struct nfsnode *np = VTONFS(vp);
 837
 838         KASSERT(vp->v_type == VDIR, ("nfs: invaldir not dir"));
 839         nfs_dircookie_lock(np);
 840         np->n_direofoffset = 0;
 841         np->n_cookieverf.nfsuquad[0] = 0;
 842         np->n_cookieverf.nfsuquad[1] = 0;
 843         if (LIST_FIRST(&np->n_cookies))
 844                 LIST_FIRST(&np->n_cookies)->ndm_eocookie = 0;
 845         nfs_dircookie_unlock(np);
 846 }
 847
 848 /*
 849  * The write verifier has changed (probably due to a server reboot), so all
 850  * B_NEEDCOMMIT blocks will have to be written again. Since they are on the
 851  * dirty block list as B_DELWRI, all this takes is clearing the B_NEEDCOMMIT
 852  * and B_CLUSTEROK flags.  Once done the new write verifier can be set for the
 853  * mount point.
 854  *
 855  * B_CLUSTEROK must be cleared along with B_NEEDCOMMIT because stage 1 data
 856  * writes are not clusterable.
 857  */
 858 void
 859 nfs_clearcommit(struct mount *mp)
 860 {
 861         struct vnode *vp, *nvp;
 862         struct buf *bp, *nbp;
 863         struct bufobj *bo;
 864
 865         MNT_ILOCK(mp);
 866         MNT_VNODE_FOREACH(vp, mp, nvp) {
 867                 bo = &vp->v_bufobj;
 868                 VI_LOCK(vp);
 869                 if (vp->v_iflag & VI_DOOMED) {
 870                         VI_UNLOCK(vp);
 871                         continue;
 872                 }
 873                 vholdl(vp);
 874                 VI_UNLOCK(vp);
 875                 MNT_IUNLOCK(mp);
 876                 BO_LOCK(bo);
 877                 TAILQ_FOREACH_SAFE(bp, &bo->bo_dirty.bv_hd, b_bobufs, nbp) {
 878                         if (!BUF_ISLOCKED(bp) &&
 879                             (bp->b_flags & (B_DELWRI | B_NEEDCOMMIT))
 880                                 == (B_DELWRI | B_NEEDCOMMIT))
 881                                 bp->b_flags &= ~(B_NEEDCOMMIT | B_CLUSTEROK);
 882                 }
 883                 BO_UNLOCK(bo);
 884                 vdrop(vp);
 885                 MNT_ILOCK(mp);
 886         }
 887         MNT_IUNLOCK(mp);
 888 }
 889
 890 /*
 891  * Helper functions for former macros.  Some of these should be
 892  * moved to their callers.
 893  */
 894
 895 int
 896 nfsm_mtofh_xx(struct vnode *d, struct vnode **v, int v3, int *f,
 897     struct mbuf **md, caddr_t *dpos)
 898 {
 899         struct nfsnode *ttnp;
 900         struct vnode *ttvp;
 901         nfsfh_t *ttfhp;
 902         u_int32_t *tl;
 903         int ttfhsize;
 904         int t1;
 905
 906         if (v3) {
 907                 tl = nfsm_dissect_xx(NFSX_UNSIGNED, md, dpos);
 908                 if (tl == NULL)
 909                         return EBADRPC;
 910                 *f = fxdr_unsigned(int, *tl);
 911         } else
 912                 *f = 1;
 913         if (*f) {
 914                 t1 = nfsm_getfh_xx(&ttfhp, &ttfhsize, (v3), md, dpos);
 915                 if (t1 != 0)
 916                         return t1;
 917                 t1 = nfs_nget(d->v_mount, ttfhp, ttfhsize, &ttnp, LK_EXCLUSIVE);
 918                 if (t1 != 0)
 919                         return t1;
 920                 *v = NFSTOV(ttnp);
 921         }
 922         if (v3) {
 923                 tl = nfsm_dissect_xx(NFSX_UNSIGNED, md, dpos);
 924                 if (tl == NULL)
 925                         return EBADRPC;
 926                 if (*f)
 927                         *f = fxdr_unsigned(int, *tl);
 928                 else if (fxdr_unsigned(int, *tl))
 929                         nfsm_adv_xx(NFSX_V3FATTR, md, dpos);
 930         }
 931         if (*f) {
 932                 ttvp = *v;
 933                 t1 = nfs_loadattrcache(&ttvp, md, dpos, NULL, 0);
 934                 if (t1)
 935                         return t1;
 936                 *v = ttvp;
 937         }
 938         return 0;
 939 }
 940
 941 int
 942 nfsm_getfh_xx(nfsfh_t **f, int *s, int v3, struct mbuf **md, caddr_t *dpos)
 943 {
 944         u_int32_t *tl;
 945
 946         if (v3) {
 947                 tl = nfsm_dissect_xx(NFSX_UNSIGNED, md, dpos);
 948                 if (tl == NULL)
 949                         return EBADRPC;
 950                 *s = fxdr_unsigned(int, *tl);
 951                 if (*s <= 0 || *s > NFSX_V3FHMAX)
 952                         return EBADRPC;
 953         } else
 954                 *s = NFSX_V2FH;
 955         *f = nfsm_dissect_xx(nfsm_rndup(*s), md, dpos);
 956         if (*f == NULL)
 957                 return EBADRPC;
 958         else
 959                 return 0;
 960 }
 961
 962
 963 int
 964 nfsm_loadattr_xx(struct vnode **v, struct vattr *va, struct mbuf **md,
 965                  caddr_t *dpos)
 966 {
 967         int t1;
 968
 969         struct vnode *ttvp = *v;
 970         t1 = nfs_loadattrcache(&ttvp, md, dpos, va, 0);
 971         if (t1 != 0)
 972                 return t1;
 973         *v = ttvp;
 974         return 0;
 975 }
 976
 977 int
 978 nfsm_postop_attr_xx(struct vnode **v, int *f, struct mbuf **md,
 979                     caddr_t *dpos)
 980 {
 981         u_int32_t *tl;
 982         int t1;
 983
 984         struct vnode *ttvp = *v;
 985         tl = nfsm_dissect_xx(NFSX_UNSIGNED, md, dpos);
 986         if (tl == NULL)
 987                 return EBADRPC;
 988         *f = fxdr_unsigned(int, *tl);
 989         if (*f != 0) {
 990                 t1 = nfs_loadattrcache(&ttvp, md, dpos, NULL, 1);
 991                 if (t1 != 0) {
 992                         *f = 0;
 993                         return t1;
 994                 }
 995                 *v = ttvp;
 996         }
 997         return 0;
 998 }
 999
1000 int
1001 nfsm_wcc_data_xx(struct vnode **v, int *f, struct mbuf **md, caddr_t *dpos)
1002 {
1003         u_int32_t *tl;
1004         int ttattrf, ttretf = 0;
1005         int t1;
1006
1007         tl = nfsm_dissect_xx(NFSX_UNSIGNED, md, dpos);
1008         if (tl == NULL)
1009                 return EBADRPC;
1010         if (*tl == nfs_true) {
1011                 tl = nfsm_dissect_xx(6 * NFSX_UNSIGNED, md, dpos);
1012                 if (tl == NULL)
1013                         return EBADRPC;
1014                 mtx_lock(&(VTONFS(*v))->n_mtx);
1015                 if (*f)
1016                         ttretf = (VTONFS(*v)->n_mtime.tv_sec == fxdr_unsigned(u_int32_t, *(tl + 2)) &&
1017                                   VTONFS(*v)->n_mtime.tv_nsec == fxdr_unsigned(u_int32_t, *(tl + 3)));
1018                 mtx_unlock(&(VTONFS(*v))->n_mtx);
1019         }
1020         t1 = nfsm_postop_attr_xx(v, &ttattrf, md, dpos);
1021         if (t1)
1022                 return t1;
1023         if (*f)
1024                 *f = ttretf;
1025         else
1026                 *f = ttattrf;
1027         return 0;
1028 }
1029
1030 int
1031 nfsm_strtom_xx(const char *a, int s, int m, struct mbuf **mb, caddr_t *bpos)
1032 {
1033         u_int32_t *tl;
1034         int t1;
1035
1036         if (s > m)
1037                 return ENAMETOOLONG;
1038         t1 = nfsm_rndup(s) + NFSX_UNSIGNED;
1039         if (t1 <= M_TRAILINGSPACE(*mb)) {
1040                 tl = nfsm_build_xx(t1, mb, bpos);
1041                 *tl++ = txdr_unsigned(s);
1042                 *(tl + ((t1 >> 2) - 2)) = 0;
1043                 bcopy(a, tl, s);
1044         } else {
1045                 t1 = nfsm_strtmbuf(mb, bpos, a, s);
1046                 if (t1 != 0)
1047                         return t1;
1048         }
1049         return 0;
1050 }
1051
1052 int
1053 nfsm_fhtom_xx(struct vnode *v, int v3, struct mbuf **mb, caddr_t *bpos)
1054 {
1055         u_int32_t *tl;
1056         int t1;
1057         caddr_t cp;
1058
1059         if (v3) {
1060                 t1 = nfsm_rndup(VTONFS(v)->n_fhsize) + NFSX_UNSIGNED;
1061                 if (t1 < M_TRAILINGSPACE(*mb)) {
1062                         tl = nfsm_build_xx(t1, mb, bpos);
1063                         *tl++ = txdr_unsigned(VTONFS(v)->n_fhsize);
1064                         *(tl + ((t1 >> 2) - 2)) = 0;
1065                         bcopy(VTONFS(v)->n_fhp, tl, VTONFS(v)->n_fhsize);
1066                 } else {
1067                         t1 = nfsm_strtmbuf(mb, bpos,
1068                             (const char *)VTONFS(v)->n_fhp,
1069                             VTONFS(v)->n_fhsize);
1070                         if (t1 != 0)
1071                                 return t1;
1072                 }
1073         } else {
1074                 cp = nfsm_build_xx(NFSX_V2FH, mb, bpos);
1075                 bcopy(VTONFS(v)->n_fhp, cp, NFSX_V2FH);
1076         }
1077         return 0;
1078 }
1079
1080 void
1081 nfsm_v3attrbuild_xx(struct vattr *va, int full, struct mbuf **mb,
1082     caddr_t *bpos)
1083 {
1084         u_int32_t *tl;
1085
1086         if (va->va_mode != (mode_t)VNOVAL) {
1087                 tl = nfsm_build_xx(2 * NFSX_UNSIGNED, mb, bpos);
1088                 *tl++ = nfs_true;
1089                 *tl = txdr_unsigned(va->va_mode);
1090         } else {
1091                 tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1092                 *tl = nfs_false;
1093         }
1094         if (full && va->va_uid != (uid_t)VNOVAL) {
1095                 tl = nfsm_build_xx(2 * NFSX_UNSIGNED, mb, bpos);
1096                 *tl++ = nfs_true;
1097                 *tl = txdr_unsigned(va->va_uid);
1098         } else {
1099                 tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1100                 *tl = nfs_false;
1101         }
1102         if (full && va->va_gid != (gid_t)VNOVAL) {
1103                 tl = nfsm_build_xx(2 * NFSX_UNSIGNED, mb, bpos);
1104                 *tl++ = nfs_true;
1105                 *tl = txdr_unsigned(va->va_gid);
1106         } else {
1107                 tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1108                 *tl = nfs_false;
1109         }
1110         if (full && va->va_size != VNOVAL) {
1111                 tl = nfsm_build_xx(3 * NFSX_UNSIGNED, mb, bpos);
1112                 *tl++ = nfs_true;
1113                 txdr_hyper(va->va_size, tl);
1114         } else {
1115                 tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1116                 *tl = nfs_false;
1117         }
1118         if (va->va_atime.tv_sec != VNOVAL) {
1119                 if (va->va_atime.tv_sec != time_second) {
1120                         tl = nfsm_build_xx(3 * NFSX_UNSIGNED, mb, bpos);
1121                         *tl++ = txdr_unsigned(NFSV3SATTRTIME_TOCLIENT);
1122                         txdr_nfsv3time(&va->va_atime, tl);
1123                 } else {
1124                         tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1125                         *tl = txdr_unsigned(NFSV3SATTRTIME_TOSERVER);
1126                 }
1127         } else {
1128                 tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1129                 *tl = txdr_unsigned(NFSV3SATTRTIME_DONTCHANGE);
1130         }
1131         if (va->va_mtime.tv_sec != VNOVAL) {
1132                 if (va->va_mtime.tv_sec != time_second) {
1133                         tl = nfsm_build_xx(3 * NFSX_UNSIGNED, mb, bpos);
1134                         *tl++ = txdr_unsigned(NFSV3SATTRTIME_TOCLIENT);
1135                         txdr_nfsv3time(&va->va_mtime, tl);
1136                 } else {
1137                         tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1138                         *tl = txdr_unsigned(NFSV3SATTRTIME_TOSERVER);
1139                 }
1140         } else {
1141                 tl = nfsm_build_xx(NFSX_UNSIGNED, mb, bpos);
1142                 *tl = txdr_unsigned(NFSV3SATTRTIME_DONTCHANGE);
1143         }
1144 }