2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 * 3. 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.
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
32 * from nfs_node.c 8.6 (Berkeley) 5/22/95
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/fcntl.h>
42 #include <sys/malloc.h>
43 #include <sys/mount.h>
44 #include <sys/namei.h>
46 #include <sys/socket.h>
47 #include <sys/sysctl.h>
48 #include <sys/taskqueue.h>
49 #include <sys/vnode.h>
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>
59 #include <nfs/nfs_lock.h>
61 extern struct vop_vector newnfs_vnodeops;
62 extern struct buf_ops buf_ops_newnfs;
63 MALLOC_DECLARE(M_NEWNFSREQ);
65 uma_zone_t newnfsnode_zone;
67 const char nfs_vnode_tag[] = "nfs";
69 static void nfs_freesillyrename(void *arg, __unused int pending);
75 newnfsnode_zone = uma_zcreate("NCLNODE", sizeof(struct nfsnode), NULL,
76 NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
82 uma_zdestroy(newnfsnode_zone);
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.
95 ncl_nget(struct mount *mntp, u_int8_t *fhp, int fhsize, struct nfsnode **npp,
98 struct thread *td = curthread; /* XXX */
104 struct nfsmount *nmp;
107 nmp = VFSTONFS(mntp);
110 hash = fnv_32_buf(fhp, fhsize, FNV1_32_INIT);
112 MALLOC(nfhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize,
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);
125 np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO);
127 error = getnewvnode(nfs_vnode_tag, mntp, &newnfs_vnodeops, &nvp);
129 uma_zfree(newnfsnode_zone, np);
133 KASSERT(vp->v_bufobj.bo_bsize != 0, ("ncl_nget: bo_bsize == 0"));
134 vp->v_bufobj.bo_ops = &buf_ops_newnfs;
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).
143 mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK);
145 * NFS supports recursive and shared locking.
147 lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
151 * Are we getting the root? If so, make sure the vnode flags
154 if ((fhsize == nmp->nm_fhsize) &&
155 !bcmp(fhp, nmp->nm_fh, fhsize)) {
156 if (vp->v_type == VNON)
158 vp->v_vflag |= VV_ROOT;
161 MALLOC(np->n_fhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize,
163 bcopy(fhp, np->n_fhp->nfh_fh, fhsize);
164 np->n_fhp->nfh_len = fhsize;
165 error = insmntque(vp, mntp);
168 FREE((caddr_t)np->n_fhp, M_NFSFH);
169 mtx_destroy(&np->n_mtx);
170 uma_zfree(newnfsnode_zone, np);
173 error = vfs_hash_insert(vp, hash, lkflags,
174 td, &nvp, newnfs_vncmpf, np->n_fhp);
179 /* vfs_hash_insert() vput()'s the losing vnode */
188 * Do the vrele(sp->s_dvp) as a separate task in order to avoid a
189 * deadlock because of a LOR when vrele() locks the directory vnode.
192 nfs_freesillyrename(void *arg, __unused int pending)
194 struct sillyrename *sp;
198 free(sp, M_NEWNFSREQ);
202 ncl_releasesillyrename(struct vnode *vp, struct thread *td)
205 struct sillyrename *sp;
207 ASSERT_VOP_ELOCKED(vp, "releasesillyrename");
209 mtx_assert(&np->n_mtx, MA_OWNED);
210 if (vp->v_type != VDIR) {
211 sp = np->n_sillyrename;
212 np->n_sillyrename = NULL;
216 mtx_unlock(&np->n_mtx);
217 (void) ncl_vinvalbuf(vp, 0, td, 1);
219 * Remove the silly file that was rename'd earlier
221 ncl_removeit(sp, vp);
223 TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp);
224 taskqueue_enqueue(taskqueue_thread, &sp->s_task);
225 mtx_lock(&np->n_mtx);
230 ncl_inactive(struct vop_inactive_args *ap)
232 struct vnode *vp = ap->a_vp;
236 if (NFS_ISV4(vp) && vp->v_type == VREG) {
238 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
239 * Close operations are delayed until now. Any dirty
240 * buffers/pages must be flushed before the close, so that the
241 * stateid is available for the writes.
243 if (vp->v_object != NULL) {
244 VM_OBJECT_WLOCK(vp->v_object);
245 retv = vm_object_page_clean(vp->v_object, 0, 0,
247 VM_OBJECT_WUNLOCK(vp->v_object);
251 (void)ncl_flush(vp, MNT_WAIT, ap->a_td, 1, 0);
252 (void)nfsrpc_close(vp, 1, ap->a_td);
257 mtx_lock(&np->n_mtx);
258 ncl_releasesillyrename(vp, ap->a_td);
261 * NMODIFIED means that there might be dirty/stale buffers
262 * associated with the NFS vnode.
263 * NDSCOMMIT means that the file is on a pNFS server and commits
264 * should be done to the DS.
265 * None of the other flags are meaningful after the vnode is unused.
267 np->n_flag &= (NMODIFIED | NDSCOMMIT);
268 mtx_unlock(&np->n_mtx);
273 * Reclaim an nfsnode so that it can be used for other purposes.
276 ncl_reclaim(struct vop_reclaim_args *ap)
278 struct vnode *vp = ap->a_vp;
279 struct nfsnode *np = VTONFS(vp);
280 struct nfsdmap *dp, *dp2;
283 * If the NLM is running, give it a chance to abort pending
286 if (nfs_reclaim_p != NULL)
289 mtx_lock(&np->n_mtx);
290 ncl_releasesillyrename(vp, ap->a_td);
291 mtx_unlock(&np->n_mtx);
294 * Destroy the vm object and flush associated pages.
296 vnode_destroy_vobject(vp);
298 if (NFS_ISV4(vp) && vp->v_type == VREG)
300 * We can now safely close any remaining NFSv4 Opens for
301 * this file. Most opens will have already been closed by
302 * ncl_inactive(), but there are cases where it is not
303 * called, so we need to do it again here.
305 (void) nfsrpc_close(vp, 1, ap->a_td);
310 * Call nfscl_reclaimnode() to save attributes in the delegation,
313 if (vp->v_type == VREG)
314 nfscl_reclaimnode(vp);
317 * Free up any directory cookie structures and
318 * large file handle structures that might be associated with
321 if (vp->v_type == VDIR) {
322 dp = LIST_FIRST(&np->n_cookies);
325 dp = LIST_NEXT(dp, ndm_list);
326 FREE((caddr_t)dp2, M_NFSDIROFF);
329 if (np->n_writecred != NULL)
330 crfree(np->n_writecred);
331 FREE((caddr_t)np->n_fhp, M_NFSFH);
332 if (np->n_v4 != NULL)
333 FREE((caddr_t)np->n_v4, M_NFSV4NODE);
334 mtx_destroy(&np->n_mtx);
335 uma_zfree(newnfsnode_zone, vp->v_data);
341 * Invalidate both the access and attribute caches for this vnode.
344 ncl_invalcaches(struct vnode *vp)
346 struct nfsnode *np = VTONFS(vp);
349 mtx_lock(&np->n_mtx);
350 for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
351 np->n_accesscache[i].stamp = 0;
352 KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
354 KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
355 mtx_unlock(&np->n_mtx);