sys/nfsclient/nfs_node.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_node.c  8.6 (Berkeley) 5/22/95
  33  */
  34
  35 #include <sys/cdefs.h>
  36 __FBSDID("$FreeBSD$");
  37
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/fcntl.h>
  41 #include <sys/fnv_hash.h>
  42 #include <sys/lock.h>
  43 #include <sys/malloc.h>
  44 #include <sys/mbuf.h>
  45 #include <sys/mount.h>
  46 #include <sys/namei.h>
  47 #include <sys/proc.h>
  48 #include <sys/socket.h>
  49 #include <sys/sysctl.h>
  50 #include <sys/vnode.h>
  51
  52 #include <vm/uma.h>
  53
  54 #include <nfs/nfsproto.h>
  55 #include <nfs/nfs_lock.h>
  56 #include <nfsclient/nfs.h>
  57 #include <nfsclient/nfsnode.h>
  58 #include <nfsclient/nfsmount.h>
  59
  60 static uma_zone_t nfsnode_zone;
  61
  62 #define TRUE    1
  63 #define FALSE   0
  64
  65 void
  66 nfs_nhinit(void)
  67 {
  68
  69         nfsnode_zone = uma_zcreate("NFSNODE", sizeof(struct nfsnode), NULL,
  70             NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
  71 }
  72
  73 void
  74 nfs_nhuninit(void)
  75 {
  76         uma_zdestroy(nfsnode_zone);
  77 }
  78
  79 struct nfs_vncmp {
  80         int     fhsize;
  81         void    *fh;
  82 };
  83
  84 static int
  85 nfs_vncmpf(struct vnode *vp, void *arg)
  86 {
  87         struct nfs_vncmp *a;
  88         struct nfsnode *np;
  89
  90         a = arg;
  91         np = VTONFS(vp);
  92         return (bcmp(a->fh, np->n_fhp, a->fhsize));
  93 }
  94
  95 /*
  96  * Look up a vnode/nfsnode by file handle.
  97  * Callers must check for mount points!!
  98  * In all cases, a pointer to a
  99  * nfsnode structure is returned.
 100  */
 101 int
 102 nfs_nget(struct mount *mntp, nfsfh_t *fhp, int fhsize, struct nfsnode **npp, int flags)
 103 {
 104         struct thread *td = curthread;  /* XXX */
 105         struct nfsnode *np;
 106         struct vnode *vp;
 107         struct vnode *nvp;
 108         int error;
 109         u_int hash;
 110         struct nfsmount *nmp;
 111         struct nfs_vncmp ncmp;
 112
 113         nmp = VFSTONFS(mntp);
 114         *npp = NULL;
 115
 116         hash = fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT);
 117         ncmp.fhsize = fhsize;
 118         ncmp.fh = fhp;
 119
 120         error = vfs_hash_get(mntp, hash, flags,
 121             td, &nvp, nfs_vncmpf, &ncmp);
 122         if (error)
 123                 return (error);
 124         if (nvp != NULL) {
 125                 *npp = VTONFS(nvp);
 126                 return (0);
 127         }
 128
 129         /*
 130          * Allocate before getnewvnode since doing so afterward
 131          * might cause a bogus v_data pointer to get dereferenced
 132          * elsewhere if zalloc should block.
 133          */
 134         np = uma_zalloc(nfsnode_zone, M_WAITOK | M_ZERO);
 135
 136         error = getnewvnode("nfs", mntp, &nfs_vnodeops, &nvp);
 137         if (error) {
 138                 uma_zfree(nfsnode_zone, np);
 139                 return (error);
 140         }
 141         vp = nvp;
 142         vp->v_bufobj.bo_ops = &buf_ops_nfs;
 143         vp->v_data = np;
 144         np->n_vnode = vp;
 145         /*
 146          * Initialize the mutex even if the vnode is going to be a loser.
 147          * This simplifies the logic in reclaim, which can then unconditionally
 148          * destroy the mutex (in the case of the loser, or if hash_insert happened
 149          * to return an error no special casing is needed).
 150          */
 151         mtx_init(&np->n_mtx, "NFSnode lock", NULL, MTX_DEF);
 152         /*
 153          * NFS supports recursive and shared locking.
 154          */
 155         VN_LOCK_AREC(vp);
 156         VN_LOCK_ASHARE(vp);
 157         if (fhsize > NFS_SMALLFH) {
 158                 np->n_fhp = malloc(fhsize, M_NFSBIGFH, M_WAITOK);
 159         } else
 160                 np->n_fhp = &np->n_fh;
 161         bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
 162         np->n_fhsize = fhsize;
 163         lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
 164         error = insmntque(vp, mntp);
 165         if (error != 0) {
 166                 *npp = NULL;
 167                 if (np->n_fhsize > NFS_SMALLFH) {
 168                         free((caddr_t)np->n_fhp, M_NFSBIGFH);
 169                 }
 170                 mtx_destroy(&np->n_mtx);
 171                 uma_zfree(nfsnode_zone, np);
 172                 return (error);
 173         }
 174         error = vfs_hash_insert(vp, hash, flags,
 175             td, &nvp, nfs_vncmpf, &ncmp);
 176         if (error)
 177                 return (error);
 178         if (nvp != NULL) {
 179                 *npp = VTONFS(nvp);
 180                 /* vfs_hash_insert() vput()'s the losing vnode */
 181                 return (0);
 182         }
 183         *npp = np;
 184
 185         return (0);
 186 }
 187
 188 int
 189 nfs_inactive(struct vop_inactive_args *ap)
 190 {
 191         struct nfsnode *np;
 192         struct sillyrename *sp;
 193         struct thread *td = curthread;  /* XXX */
 194
 195         np = VTONFS(ap->a_vp);
 196         if (prtactive && vrefcnt(ap->a_vp) != 0)
 197                 vprint("nfs_inactive: pushing active", ap->a_vp);
 198         mtx_lock(&np->n_mtx);
 199         if (ap->a_vp->v_type != VDIR) {
 200                 sp = np->n_sillyrename;
 201                 np->n_sillyrename = NULL;
 202         } else
 203                 sp = NULL;
 204         if (sp) {
 205                 mtx_unlock(&np->n_mtx);
 206                 (void)nfs_vinvalbuf(ap->a_vp, 0, td, 1);
 207                 /*
 208                  * Remove the silly file that was rename'd earlier
 209                  */
 210                 (sp->s_removeit)(sp);
 211                 crfree(sp->s_cred);
 212                 vrele(sp->s_dvp);
 213                 free((caddr_t)sp, M_NFSREQ);
 214                 mtx_lock(&np->n_mtx);
 215         }
 216         np->n_flag &= NMODIFIED;
 217         mtx_unlock(&np->n_mtx);
 218         return (0);
 219 }
 220
 221 /*
 222  * Reclaim an nfsnode so that it can be used for other purposes.
 223  */
 224 int
 225 nfs_reclaim(struct vop_reclaim_args *ap)
 226 {
 227         struct vnode *vp = ap->a_vp;
 228         struct nfsnode *np = VTONFS(vp);
 229         struct nfsdmap *dp, *dp2;
 230
 231         if (prtactive && vrefcnt(vp) != 0)
 232                 vprint("nfs_reclaim: pushing active", vp);
 233
 234         /*
 235          * If the NLM is running, give it a chance to abort pending
 236          * locks.
 237          */
 238         if (nfs_reclaim_p)
 239                 nfs_reclaim_p(ap);
 240
 241         /*
 242          * Destroy the vm object and flush associated pages.
 243          */
 244         vnode_destroy_vobject(vp);
 245
 246         vfs_hash_remove(vp);
 247
 248         /*
 249          * Free up any directory cookie structures and
 250          * large file handle structures that might be associated with
 251          * this nfs node.
 252          */
 253         if (vp->v_type == VDIR) {
 254                 dp = LIST_FIRST(&np->n_cookies);
 255                 while (dp) {
 256                         dp2 = dp;
 257                         dp = LIST_NEXT(dp, ndm_list);
 258                         free((caddr_t)dp2, M_NFSDIROFF);
 259                 }
 260         }
 261         if (np->n_fhsize > NFS_SMALLFH) {
 262                 free((caddr_t)np->n_fhp, M_NFSBIGFH);
 263         }
 264         mtx_destroy(&np->n_mtx);
 265         uma_zfree(nfsnode_zone, vp->v_data);
 266         vp->v_data = NULL;
 267         return (0);
 268 }