sys/fs/nfsclient/nfs_clnode.c

   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  *      from nfs_node.c 8.6 (Berkeley) 5/22/95
  35  */
  36
  37 #include <sys/cdefs.h>
  38 #include <sys/param.h>
  39 #include <sys/systm.h>
  40 #include <sys/fcntl.h>
  41 #include <sys/lock.h>
  42 #include <sys/malloc.h>
  43 #include <sys/mount.h>
  44 #include <sys/namei.h>
  45 #include <sys/proc.h>
  46 #include <sys/socket.h>
  47 #include <sys/sysctl.h>
  48 #include <sys/taskqueue.h>
  49 #include <sys/vnode.h>
  50
  51 #include <vm/uma.h>
  52
  53 #include <fs/nfs/nfsport.h>
  54 #include <fs/nfsclient/nfsnode.h>
  55 #include <fs/nfsclient/nfsmount.h>
  56 #include <fs/nfsclient/nfs.h>
  57 #include <fs/nfsclient/nfs_kdtrace.h>
  58
  59 #include <nfs/nfs_lock.h>
  60
  61 extern struct vop_vector newnfs_vnodeops;
  62 extern struct buf_ops buf_ops_newnfs;
  63 MALLOC_DECLARE(M_NEWNFSREQ);
  64
  65 uma_zone_t newnfsnode_zone;
  66
  67 const char nfs_vnode_tag[] = "nfs";
  68
  69 static void     nfs_freesillyrename(void *arg, __unused int pending);
  70
  71 void
  72 ncl_nhinit(void)
  73 {
  74
  75         newnfsnode_zone = uma_zcreate("NCLNODE", sizeof(struct nfsnode), NULL,
  76             NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
  77 }
  78
  79 void
  80 ncl_nhuninit(void)
  81 {
  82         uma_zdestroy(newnfsnode_zone);
  83 }
  84
  85 /*
  86  * ONLY USED FOR THE ROOT DIRECTORY. nfscl_nget() does the rest. If this
  87  * function is going to be used to get Regular Files, code must be added
  88  * to fill in the "struct nfsv4node".
  89  * Look up a vnode/nfsnode by file handle.
  90  * Callers must check for mount points!!
  91  * In all cases, a pointer to a
  92  * nfsnode structure is returned.
  93  */
  94 int
  95 ncl_nget(struct mount *mntp, u_int8_t *fhp, int fhsize, struct nfsnode **npp,
  96     int lkflags)
  97 {
  98         struct thread *td = curthread;  /* XXX */
  99         struct nfsnode *np;
 100         struct vnode *vp;
 101         struct vnode *nvp;
 102         int error;
 103         u_int hash;
 104         struct nfsmount *nmp;
 105         struct nfsfh *nfhp;
 106
 107         nmp = VFSTONFS(mntp);
 108         *npp = NULL;
 109
 110         hash = fnv_32_buf(fhp, fhsize, FNV1_32_INIT);
 111
 112         nfhp = malloc(sizeof (struct nfsfh) + fhsize,
 113             M_NFSFH, M_WAITOK);
 114         bcopy(fhp, &nfhp->nfh_fh[0], fhsize);
 115         nfhp->nfh_len = fhsize;
 116         error = vfs_hash_get(mntp, hash, lkflags,
 117             td, &nvp, newnfs_vncmpf, nfhp);
 118         free(nfhp, M_NFSFH);
 119         if (error)
 120                 return (error);
 121         if (nvp != NULL) {
 122                 *npp = VTONFS(nvp);
 123                 return (0);
 124         }
 125         np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO);
 126
 127         error = getnewvnode(nfs_vnode_tag, mntp, &newnfs_vnodeops, &nvp);
 128         if (error) {
 129                 uma_zfree(newnfsnode_zone, np);
 130                 return (error);
 131         }
 132         vp = nvp;
 133         KASSERT(vp->v_bufobj.bo_bsize != 0, ("ncl_nget: bo_bsize == 0"));
 134         vp->v_bufobj.bo_ops = &buf_ops_newnfs;
 135         vp->v_data = np;
 136         np->n_vnode = vp;
 137         /*
 138          * Initialize the mutex even if the vnode is going to be a loser.
 139          * This simplifies the logic in reclaim, which can then unconditionally
 140          * destroy the mutex (in the case of the loser, or if hash_insert
 141          * happened to return an error no special casing is needed).
 142          */
 143         mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK);
 144         lockinit(&np->n_excl, PVFS, "nfsupg", VLKTIMEOUT, LK_NOSHARE |
 145             LK_CANRECURSE);
 146
 147         /*
 148          * NFS supports recursive and shared locking.
 149          */
 150         lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
 151         VN_LOCK_AREC(vp);
 152         VN_LOCK_ASHARE(vp);
 153         /*
 154          * Are we getting the root? If so, make sure the vnode flags
 155          * are correct
 156          */
 157         if (fhsize == NFSX_FHMAX + 1 || (fhsize == nmp->nm_fhsize &&
 158             !bcmp(fhp, nmp->nm_fh, fhsize))) {
 159                 if (vp->v_type == VNON)
 160                         vp->v_type = VDIR;
 161                 vp->v_vflag |= VV_ROOT;
 162         }
 163
 164         vp->v_vflag |= VV_VMSIZEVNLOCK;
 165
 166         np->n_fhp = malloc(sizeof (struct nfsfh) + fhsize,
 167             M_NFSFH, M_WAITOK);
 168         bcopy(fhp, np->n_fhp->nfh_fh, fhsize);
 169         np->n_fhp->nfh_len = fhsize;
 170         error = insmntque(vp, mntp);
 171         if (error != 0) {
 172                 *npp = NULL;
 173                 free(np->n_fhp, M_NFSFH);
 174                 mtx_destroy(&np->n_mtx);
 175                 lockdestroy(&np->n_excl);
 176                 uma_zfree(newnfsnode_zone, np);
 177                 return (error);
 178         }
 179         vn_set_state(vp, VSTATE_CONSTRUCTED);
 180         error = vfs_hash_insert(vp, hash, lkflags,
 181             td, &nvp, newnfs_vncmpf, np->n_fhp);
 182         if (error)
 183                 return (error);
 184         if (nvp != NULL) {
 185                 *npp = VTONFS(nvp);
 186                 /* vfs_hash_insert() vput()'s the losing vnode */
 187                 return (0);
 188         }
 189         *npp = np;
 190
 191         return (0);
 192 }
 193
 194 /*
 195  * Do the vrele(sp->s_dvp) as a separate task in order to avoid a
 196  * deadlock because of a LOR when vrele() locks the directory vnode.
 197  */
 198 static void
 199 nfs_freesillyrename(void *arg, __unused int pending)
 200 {
 201         struct sillyrename *sp;
 202
 203         sp = arg;
 204         vrele(sp->s_dvp);
 205         free(sp, M_NEWNFSREQ);
 206 }
 207
 208 static void
 209 ncl_releasesillyrename(struct vnode *vp, struct thread *td)
 210 {
 211         struct nfsnode *np;
 212         struct sillyrename *sp;
 213
 214         ASSERT_VOP_ELOCKED(vp, "releasesillyrename");
 215         np = VTONFS(vp);
 216         NFSASSERTNODE(np);
 217         if (vp->v_type != VDIR) {
 218                 sp = np->n_sillyrename;
 219                 np->n_sillyrename = NULL;
 220         } else
 221                 sp = NULL;
 222         if (sp != NULL) {
 223                 NFSUNLOCKNODE(np);
 224                 (void) ncl_vinvalbuf(vp, 0, td, 1);
 225                 /*
 226                  * Remove the silly file that was rename'd earlier
 227                  */
 228                 ncl_removeit(sp, vp);
 229                 crfree(sp->s_cred);
 230                 TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp);
 231                 taskqueue_enqueue(taskqueue_thread, &sp->s_task);
 232                 NFSLOCKNODE(np);
 233         }
 234 }
 235
 236 int
 237 ncl_inactive(struct vop_inactive_args *ap)
 238 {
 239         struct vnode *vp = ap->a_vp;
 240         struct nfsnode *np;
 241         struct thread *td;
 242         boolean_t retv;
 243
 244         td = curthread;
 245         np = VTONFS(vp);
 246         if (NFS_ISV4(vp) && vp->v_type == VREG) {
 247                 NFSLOCKNODE(np);
 248                 np->n_openstateid = NULL;
 249                 NFSUNLOCKNODE(np);
 250                 /*
 251                  * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
 252                  * Close operations are delayed until now. Any dirty
 253                  * buffers/pages must be flushed before the close, so that the
 254                  * stateid is available for the writes.
 255                  */
 256                 if (vp->v_object != NULL) {
 257                         VM_OBJECT_WLOCK(vp->v_object);
 258                         retv = vm_object_page_clean(vp->v_object, 0, 0,
 259                             OBJPC_SYNC);
 260                         VM_OBJECT_WUNLOCK(vp->v_object);
 261                 } else
 262                         retv = TRUE;
 263                 if (retv == TRUE) {
 264                         (void)ncl_flush(vp, MNT_WAIT, td, 1, 0);
 265                         (void)nfsrpc_close(vp, 1, td);
 266                 }
 267         }
 268
 269         NFSLOCKNODE(np);
 270         ncl_releasesillyrename(vp, td);
 271
 272         /*
 273          * NMODIFIED means that there might be dirty/stale buffers
 274          * associated with the NFS vnode.
 275          * NDSCOMMIT means that the file is on a pNFS server and commits
 276          * should be done to the DS.
 277          * None of the other flags are meaningful after the vnode is unused.
 278          */
 279         np->n_flag &= (NMODIFIED | NDSCOMMIT);
 280         NFSUNLOCKNODE(np);
 281         return (0);
 282 }
 283
 284 /*
 285  * Reclaim an nfsnode so that it can be used for other purposes.
 286  */
 287 int
 288 ncl_reclaim(struct vop_reclaim_args *ap)
 289 {
 290         struct vnode *vp = ap->a_vp;
 291         struct nfsnode *np = VTONFS(vp);
 292         struct nfsdmap *dp, *dp2;
 293         struct thread *td;
 294         struct mount *mp;
 295
 296         td = curthread;
 297         mp = vp->v_mount;
 298
 299         /*
 300          * If the NLM is running, give it a chance to abort pending
 301          * locks.
 302          */
 303         if (nfs_reclaim_p != NULL)
 304                 nfs_reclaim_p(ap);
 305
 306         NFSLOCKNODE(np);
 307         ncl_releasesillyrename(vp, td);
 308
 309         if (NFS_ISV4(vp) && vp->v_type == VREG) {
 310                 np->n_openstateid = NULL;
 311                 NFSUNLOCKNODE(np);
 312                 /*
 313                  * We can now safely close any remaining NFSv4 Opens for
 314                  * this file. Most opens will have already been closed by
 315                  * ncl_inactive(), but there are cases where it is not
 316                  * called, so we need to do it again here.
 317                  */
 318                 (void) nfsrpc_close(vp, 1, td);
 319                 /*
 320                  * It it unlikely a delegation will still exist, but
 321                  * if one does, it must be returned before calling
 322                  * vfs_hash_remove(), since it cannot be recalled once the
 323                  * nfs node is no longer available.
 324                  */
 325                 MNT_ILOCK(mp);
 326                 if ((mp->mnt_kern_flag & MNTK_UNMOUNTF) == 0) {
 327                         MNT_IUNLOCK(mp);
 328                         nfscl_delegreturnvp(vp, td);
 329                 } else
 330                         MNT_IUNLOCK(mp);
 331         } else
 332                 NFSUNLOCKNODE(np);
 333
 334         vfs_hash_remove(vp);
 335
 336         /*
 337          * Call nfscl_reclaimnode() to save attributes in the delegation,
 338          * as required.
 339          */
 340         if (vp->v_type == VREG)
 341                 nfscl_reclaimnode(vp);
 342
 343         /*
 344          * Free up any directory cookie structures and
 345          * large file handle structures that might be associated with
 346          * this nfs node.
 347          */
 348         if (vp->v_type == VDIR) {
 349                 dp = LIST_FIRST(&np->n_cookies);
 350                 while (dp) {
 351                         dp2 = dp;
 352                         dp = LIST_NEXT(dp, ndm_list);
 353                         free(dp2, M_NFSDIROFF);
 354                 }
 355         }
 356         if (np->n_writecred != NULL)
 357                 crfree(np->n_writecred);
 358         free(np->n_fhp, M_NFSFH);
 359         if (np->n_v4 != NULL)
 360                 free(np->n_v4, M_NFSV4NODE);
 361         mtx_destroy(&np->n_mtx);
 362         lockdestroy(&np->n_excl);
 363         uma_zfree(newnfsnode_zone, vp->v_data);
 364         vp->v_data = NULL;
 365         return (0);
 366 }
 367
 368 /*
 369  * Invalidate both the access and attribute caches for this vnode.
 370  */
 371 void
 372 ncl_invalcaches(struct vnode *vp)
 373 {
 374         struct nfsnode *np = VTONFS(vp);
 375         int i;
 376
 377         NFSLOCKNODE(np);
 378         for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
 379                 np->n_accesscache[i].stamp = 0;
 380         KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
 381         np->n_attrstamp = 0;
 382         KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
 383         NFSUNLOCKNODE(np);
 384 }