1191783Srmacklem/*- 2191783Srmacklem * Copyright (c) 1989, 1993 3191783Srmacklem * The Regents of the University of California. All rights reserved. 4191783Srmacklem * 5191783Srmacklem * This code is derived from software contributed to Berkeley by 6191783Srmacklem * Rick Macklem at The University of Guelph. 7191783Srmacklem * 8191783Srmacklem * Redistribution and use in source and binary forms, with or without 9191783Srmacklem * modification, are permitted provided that the following conditions 10191783Srmacklem * are met: 11191783Srmacklem * 1. Redistributions of source code must retain the above copyright 12191783Srmacklem * notice, this list of conditions and the following disclaimer. 13191783Srmacklem * 2. Redistributions in binary form must reproduce the above copyright 14191783Srmacklem * notice, this list of conditions and the following disclaimer in the 15191783Srmacklem * documentation and/or other materials provided with the distribution. 16191783Srmacklem * 4. Neither the name of the University nor the names of its contributors 17191783Srmacklem * may be used to endorse or promote products derived from this software 18191783Srmacklem * without specific prior written permission. 19191783Srmacklem * 20191783Srmacklem * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 21191783Srmacklem * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22191783Srmacklem * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23191783Srmacklem * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 24191783Srmacklem * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25191783Srmacklem * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26191783Srmacklem * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27191783Srmacklem * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28191783Srmacklem * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29191783Srmacklem * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30191783Srmacklem * SUCH DAMAGE. 31191783Srmacklem * 32191783Srmacklem * from nfs_node.c 8.6 (Berkeley) 5/22/95 33191783Srmacklem */ 34191783Srmacklem 35191783Srmacklem#include <sys/cdefs.h> 36191783Srmacklem__FBSDID("$FreeBSD: stable/11/sys/fs/nfsclient/nfs_clnode.c 323142 2017-09-03 09:12:02Z kib $"); 37191783Srmacklem 38191783Srmacklem#include <sys/param.h> 39191783Srmacklem#include <sys/systm.h> 40214048Srmacklem#include <sys/fcntl.h> 41191783Srmacklem#include <sys/lock.h> 42191783Srmacklem#include <sys/malloc.h> 43191783Srmacklem#include <sys/mount.h> 44191783Srmacklem#include <sys/namei.h> 45191783Srmacklem#include <sys/proc.h> 46191783Srmacklem#include <sys/socket.h> 47191783Srmacklem#include <sys/sysctl.h> 48224606Srmacklem#include <sys/taskqueue.h> 49191783Srmacklem#include <sys/vnode.h> 50191783Srmacklem 51191783Srmacklem#include <vm/uma.h> 52191783Srmacklem 53191783Srmacklem#include <fs/nfs/nfsport.h> 54191783Srmacklem#include <fs/nfsclient/nfsnode.h> 55191783Srmacklem#include <fs/nfsclient/nfsmount.h> 56191783Srmacklem#include <fs/nfsclient/nfs.h> 57223280Srmacklem#include <fs/nfsclient/nfs_kdtrace.h> 58191783Srmacklem 59214048Srmacklem#include <nfs/nfs_lock.h> 60214048Srmacklem 61191783Srmacklemextern struct vop_vector newnfs_vnodeops; 62191783Srmacklemextern struct buf_ops buf_ops_newnfs; 63191783SrmacklemMALLOC_DECLARE(M_NEWNFSREQ); 64191783Srmacklem 65191783Srmacklemuma_zone_t newnfsnode_zone; 66191783Srmacklem 67291459Smckusickconst char nfs_vnode_tag[] = "nfs"; 68291459Smckusick 69224606Srmacklemstatic void nfs_freesillyrename(void *arg, __unused int pending); 70224606Srmacklem 71191783Srmacklemvoid 72191783Srmacklemncl_nhinit(void) 73191783Srmacklem{ 74191783Srmacklem 75191783Srmacklem newnfsnode_zone = uma_zcreate("NCLNODE", sizeof(struct nfsnode), NULL, 76191783Srmacklem NULL, NULL, NULL, UMA_ALIGN_PTR, 0); 77191783Srmacklem} 78191783Srmacklem 79191783Srmacklemvoid 80191783Srmacklemncl_nhuninit(void) 81191783Srmacklem{ 82191783Srmacklem uma_zdestroy(newnfsnode_zone); 83191783Srmacklem} 84191783Srmacklem 85191783Srmacklem/* 86191783Srmacklem * ONLY USED FOR THE ROOT DIRECTORY. nfscl_nget() does the rest. If this 87191783Srmacklem * function is going to be used to get Regular Files, code must be added 88191783Srmacklem * to fill in the "struct nfsv4node". 89191783Srmacklem * Look up a vnode/nfsnode by file handle. 90191783Srmacklem * Callers must check for mount points!! 91191783Srmacklem * In all cases, a pointer to a 92191783Srmacklem * nfsnode structure is returned. 93191783Srmacklem */ 94191783Srmacklemint 95220732Srmacklemncl_nget(struct mount *mntp, u_int8_t *fhp, int fhsize, struct nfsnode **npp, 96220732Srmacklem int lkflags) 97191783Srmacklem{ 98191783Srmacklem struct thread *td = curthread; /* XXX */ 99191783Srmacklem struct nfsnode *np; 100191783Srmacklem struct vnode *vp; 101191783Srmacklem struct vnode *nvp; 102191783Srmacklem int error; 103191783Srmacklem u_int hash; 104191783Srmacklem struct nfsmount *nmp; 105191783Srmacklem struct nfsfh *nfhp; 106191783Srmacklem 107191783Srmacklem nmp = VFSTONFS(mntp); 108191783Srmacklem *npp = NULL; 109191783Srmacklem 110191783Srmacklem hash = fnv_32_buf(fhp, fhsize, FNV1_32_INIT); 111191783Srmacklem 112191783Srmacklem MALLOC(nfhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize, 113191783Srmacklem M_NFSFH, M_WAITOK); 114191783Srmacklem bcopy(fhp, &nfhp->nfh_fh[0], fhsize); 115191783Srmacklem nfhp->nfh_len = fhsize; 116220732Srmacklem error = vfs_hash_get(mntp, hash, lkflags, 117191783Srmacklem td, &nvp, newnfs_vncmpf, nfhp); 118191783Srmacklem FREE(nfhp, M_NFSFH); 119191783Srmacklem if (error) 120191783Srmacklem return (error); 121191783Srmacklem if (nvp != NULL) { 122191783Srmacklem *npp = VTONFS(nvp); 123191783Srmacklem return (0); 124191783Srmacklem } 125191783Srmacklem np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO); 126191783Srmacklem 127291459Smckusick error = getnewvnode(nfs_vnode_tag, mntp, &newnfs_vnodeops, &nvp); 128191783Srmacklem if (error) { 129191783Srmacklem uma_zfree(newnfsnode_zone, np); 130191783Srmacklem return (error); 131191783Srmacklem } 132191783Srmacklem vp = nvp; 133230605Srmacklem KASSERT(vp->v_bufobj.bo_bsize != 0, ("ncl_nget: bo_bsize == 0")); 134191783Srmacklem vp->v_bufobj.bo_ops = &buf_ops_newnfs; 135191783Srmacklem vp->v_data = np; 136191783Srmacklem np->n_vnode = vp; 137191783Srmacklem /* 138191783Srmacklem * Initialize the mutex even if the vnode is going to be a loser. 139191783Srmacklem * This simplifies the logic in reclaim, which can then unconditionally 140191783Srmacklem * destroy the mutex (in the case of the loser, or if hash_insert 141191783Srmacklem * happened to return an error no special casing is needed). 142191783Srmacklem */ 143191783Srmacklem mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK); 144323142Skib lockinit(&np->n_excl, PVFS, "nfsupg", VLKTIMEOUT, LK_NOSHARE | 145323142Skib LK_CANRECURSE); 146323142Skib 147191783Srmacklem /* 148191783Srmacklem * NFS supports recursive and shared locking. 149191783Srmacklem */ 150211531Sjhb lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL); 151191783Srmacklem VN_LOCK_AREC(vp); 152191783Srmacklem VN_LOCK_ASHARE(vp); 153191783Srmacklem /* 154191783Srmacklem * Are we getting the root? If so, make sure the vnode flags 155191783Srmacklem * are correct 156191783Srmacklem */ 157191783Srmacklem if ((fhsize == nmp->nm_fhsize) && 158191783Srmacklem !bcmp(fhp, nmp->nm_fh, fhsize)) { 159191783Srmacklem if (vp->v_type == VNON) 160191783Srmacklem vp->v_type = VDIR; 161191783Srmacklem vp->v_vflag |= VV_ROOT; 162191783Srmacklem } 163191783Srmacklem 164191783Srmacklem MALLOC(np->n_fhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize, 165191783Srmacklem M_NFSFH, M_WAITOK); 166191783Srmacklem bcopy(fhp, np->n_fhp->nfh_fh, fhsize); 167191783Srmacklem np->n_fhp->nfh_len = fhsize; 168191783Srmacklem error = insmntque(vp, mntp); 169191783Srmacklem if (error != 0) { 170191783Srmacklem *npp = NULL; 171191783Srmacklem FREE((caddr_t)np->n_fhp, M_NFSFH); 172191783Srmacklem mtx_destroy(&np->n_mtx); 173323142Skib lockdestroy(&np->n_excl); 174191783Srmacklem uma_zfree(newnfsnode_zone, np); 175191783Srmacklem return (error); 176191783Srmacklem } 177220732Srmacklem error = vfs_hash_insert(vp, hash, lkflags, 178191783Srmacklem td, &nvp, newnfs_vncmpf, np->n_fhp); 179191783Srmacklem if (error) 180191783Srmacklem return (error); 181191783Srmacklem if (nvp != NULL) { 182191783Srmacklem *npp = VTONFS(nvp); 183191783Srmacklem /* vfs_hash_insert() vput()'s the losing vnode */ 184191783Srmacklem return (0); 185191783Srmacklem } 186191783Srmacklem *npp = np; 187191783Srmacklem 188191783Srmacklem return (0); 189191783Srmacklem} 190191783Srmacklem 191224606Srmacklem/* 192224606Srmacklem * Do the vrele(sp->s_dvp) as a separate task in order to avoid a 193224606Srmacklem * deadlock because of a LOR when vrele() locks the directory vnode. 194224606Srmacklem */ 195224606Srmacklemstatic void 196224606Srmacklemnfs_freesillyrename(void *arg, __unused int pending) 197224606Srmacklem{ 198224606Srmacklem struct sillyrename *sp; 199224606Srmacklem 200224606Srmacklem sp = arg; 201224606Srmacklem vrele(sp->s_dvp); 202224606Srmacklem free(sp, M_NEWNFSREQ); 203224606Srmacklem} 204224606Srmacklem 205302196Skibstatic void 206302196Skibncl_releasesillyrename(struct vnode *vp, struct thread *td) 207302196Skib{ 208302196Skib struct nfsnode *np; 209302196Skib struct sillyrename *sp; 210302196Skib 211302196Skib ASSERT_VOP_ELOCKED(vp, "releasesillyrename"); 212302196Skib np = VTONFS(vp); 213302210Skib mtx_assert(&np->n_mtx, MA_OWNED); 214302196Skib if (vp->v_type != VDIR) { 215302196Skib sp = np->n_sillyrename; 216302196Skib np->n_sillyrename = NULL; 217302196Skib } else 218302196Skib sp = NULL; 219302196Skib if (sp != NULL) { 220302196Skib mtx_unlock(&np->n_mtx); 221302196Skib (void) ncl_vinvalbuf(vp, 0, td, 1); 222302196Skib /* 223302196Skib * Remove the silly file that was rename'd earlier 224302196Skib */ 225302196Skib ncl_removeit(sp, vp); 226302196Skib crfree(sp->s_cred); 227302196Skib TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp); 228302196Skib taskqueue_enqueue(taskqueue_thread, &sp->s_task); 229302196Skib mtx_lock(&np->n_mtx); 230302196Skib } 231302196Skib} 232302196Skib 233191783Srmacklemint 234191783Srmacklemncl_inactive(struct vop_inactive_args *ap) 235191783Srmacklem{ 236193125Srmacklem struct vnode *vp = ap->a_vp; 237302210Skib struct nfsnode *np; 238237244Srmacklem boolean_t retv; 239191783Srmacklem 240193125Srmacklem if (NFS_ISV4(vp) && vp->v_type == VREG) { 241192928Srmacklem /* 242192928Srmacklem * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4 243237244Srmacklem * Close operations are delayed until now. Any dirty 244237244Srmacklem * buffers/pages must be flushed before the close, so that the 245237244Srmacklem * stateid is available for the writes. 246192928Srmacklem */ 247237244Srmacklem if (vp->v_object != NULL) { 248248084Sattilio VM_OBJECT_WLOCK(vp->v_object); 249237244Srmacklem retv = vm_object_page_clean(vp->v_object, 0, 0, 250237244Srmacklem OBJPC_SYNC); 251248084Sattilio VM_OBJECT_WUNLOCK(vp->v_object); 252237244Srmacklem } else 253237244Srmacklem retv = TRUE; 254237244Srmacklem if (retv == TRUE) { 255317577Srmacklem (void)ncl_flush(vp, MNT_WAIT, ap->a_td, 1, 0); 256237244Srmacklem (void)nfsrpc_close(vp, 1, ap->a_td); 257237244Srmacklem } 258192928Srmacklem } 259192337Srmacklem 260302210Skib np = VTONFS(vp); 261302210Skib mtx_lock(&np->n_mtx); 262302196Skib ncl_releasesillyrename(vp, ap->a_td); 263302210Skib 264302210Skib /* 265302210Skib * NMODIFIED means that there might be dirty/stale buffers 266321029Srmacklem * associated with the NFS vnode. 267321029Srmacklem * NDSCOMMIT means that the file is on a pNFS server and commits 268321029Srmacklem * should be done to the DS. 269321029Srmacklem * None of the other flags are meaningful after the vnode is unused. 270302210Skib */ 271321029Srmacklem np->n_flag &= (NMODIFIED | NDSCOMMIT); 272302210Skib mtx_unlock(&np->n_mtx); 273191783Srmacklem return (0); 274191783Srmacklem} 275191783Srmacklem 276191783Srmacklem/* 277191783Srmacklem * Reclaim an nfsnode so that it can be used for other purposes. 278191783Srmacklem */ 279191783Srmacklemint 280191783Srmacklemncl_reclaim(struct vop_reclaim_args *ap) 281191783Srmacklem{ 282191783Srmacklem struct vnode *vp = ap->a_vp; 283191783Srmacklem struct nfsnode *np = VTONFS(vp); 284191783Srmacklem struct nfsdmap *dp, *dp2; 285191783Srmacklem 286191783Srmacklem /* 287191783Srmacklem * If the NLM is running, give it a chance to abort pending 288191783Srmacklem * locks. 289191783Srmacklem */ 290214048Srmacklem if (nfs_reclaim_p != NULL) 291214048Srmacklem nfs_reclaim_p(ap); 292191783Srmacklem 293302210Skib mtx_lock(&np->n_mtx); 294302196Skib ncl_releasesillyrename(vp, ap->a_td); 295302210Skib mtx_unlock(&np->n_mtx); 296302196Skib 297191783Srmacklem /* 298191783Srmacklem * Destroy the vm object and flush associated pages. 299191783Srmacklem */ 300191783Srmacklem vnode_destroy_vobject(vp); 301191783Srmacklem 302237200Srmacklem if (NFS_ISV4(vp) && vp->v_type == VREG) 303237200Srmacklem /* 304237200Srmacklem * We can now safely close any remaining NFSv4 Opens for 305237200Srmacklem * this file. Most opens will have already been closed by 306237200Srmacklem * ncl_inactive(), but there are cases where it is not 307237200Srmacklem * called, so we need to do it again here. 308237200Srmacklem */ 309237200Srmacklem (void) nfsrpc_close(vp, 1, ap->a_td); 310237200Srmacklem 311191783Srmacklem vfs_hash_remove(vp); 312191783Srmacklem 313191783Srmacklem /* 314191783Srmacklem * Call nfscl_reclaimnode() to save attributes in the delegation, 315191783Srmacklem * as required. 316191783Srmacklem */ 317191783Srmacklem if (vp->v_type == VREG) 318191783Srmacklem nfscl_reclaimnode(vp); 319191783Srmacklem 320191783Srmacklem /* 321191783Srmacklem * Free up any directory cookie structures and 322191783Srmacklem * large file handle structures that might be associated with 323191783Srmacklem * this nfs node. 324191783Srmacklem */ 325191783Srmacklem if (vp->v_type == VDIR) { 326191783Srmacklem dp = LIST_FIRST(&np->n_cookies); 327191783Srmacklem while (dp) { 328191783Srmacklem dp2 = dp; 329191783Srmacklem dp = LIST_NEXT(dp, ndm_list); 330191783Srmacklem FREE((caddr_t)dp2, M_NFSDIROFF); 331191783Srmacklem } 332191783Srmacklem } 333235332Srmacklem if (np->n_writecred != NULL) 334235332Srmacklem crfree(np->n_writecred); 335191783Srmacklem FREE((caddr_t)np->n_fhp, M_NFSFH); 336191783Srmacklem if (np->n_v4 != NULL) 337191783Srmacklem FREE((caddr_t)np->n_v4, M_NFSV4NODE); 338191783Srmacklem mtx_destroy(&np->n_mtx); 339323142Skib lockdestroy(&np->n_excl); 340191783Srmacklem uma_zfree(newnfsnode_zone, vp->v_data); 341191783Srmacklem vp->v_data = NULL; 342191783Srmacklem return (0); 343191783Srmacklem} 344191783Srmacklem 345191783Srmacklem/* 346191783Srmacklem * Invalidate both the access and attribute caches for this vnode. 347191783Srmacklem */ 348191783Srmacklemvoid 349191783Srmacklemncl_invalcaches(struct vnode *vp) 350191783Srmacklem{ 351191783Srmacklem struct nfsnode *np = VTONFS(vp); 352191783Srmacklem int i; 353191783Srmacklem 354191783Srmacklem mtx_lock(&np->n_mtx); 355191783Srmacklem for (i = 0; i < NFS_ACCESSCACHESIZE; i++) 356191783Srmacklem np->n_accesscache[i].stamp = 0; 357223280Srmacklem KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp); 358191783Srmacklem np->n_attrstamp = 0; 359223280Srmacklem KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp); 360191783Srmacklem mtx_unlock(&np->n_mtx); 361191783Srmacklem} 362