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 * 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.
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 "opt_kdtrace.h"
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/fcntl.h>
44 #include <sys/malloc.h>
45 #include <sys/mount.h>
46 #include <sys/namei.h>
48 #include <sys/socket.h>
49 #include <sys/sysctl.h>
50 #include <sys/taskqueue.h>
51 #include <sys/vnode.h>
55 #include <fs/nfs/nfsport.h>
56 #include <fs/nfsclient/nfsnode.h>
57 #include <fs/nfsclient/nfsmount.h>
58 #include <fs/nfsclient/nfs.h>
59 #include <fs/nfsclient/nfs_kdtrace.h>
61 #include <nfs/nfs_lock.h>
63 extern struct vop_vector newnfs_vnodeops;
64 extern struct buf_ops buf_ops_newnfs;
65 MALLOC_DECLARE(M_NEWNFSREQ);
67 uma_zone_t newnfsnode_zone;
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);
127 * Allocate before getnewvnode since doing so afterward
128 * might cause a bogus v_data pointer to get dereferenced
129 * elsewhere if zalloc should block.
131 np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO);
133 error = getnewvnode("newnfs", mntp, &newnfs_vnodeops, &nvp);
135 uma_zfree(newnfsnode_zone, np);
139 KASSERT(vp->v_bufobj.bo_bsize != 0, ("ncl_nget: bo_bsize == 0"));
140 vp->v_bufobj.bo_ops = &buf_ops_newnfs;
144 * Initialize the mutex even if the vnode is going to be a loser.
145 * This simplifies the logic in reclaim, which can then unconditionally
146 * destroy the mutex (in the case of the loser, or if hash_insert
147 * happened to return an error no special casing is needed).
149 mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK);
151 * NFS supports recursive and shared locking.
153 lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
157 * Are we getting the root? If so, make sure the vnode flags
160 if ((fhsize == nmp->nm_fhsize) &&
161 !bcmp(fhp, nmp->nm_fh, fhsize)) {
162 if (vp->v_type == VNON)
164 vp->v_vflag |= VV_ROOT;
167 MALLOC(np->n_fhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize,
169 bcopy(fhp, np->n_fhp->nfh_fh, fhsize);
170 np->n_fhp->nfh_len = fhsize;
171 error = insmntque(vp, mntp);
174 FREE((caddr_t)np->n_fhp, M_NFSFH);
175 mtx_destroy(&np->n_mtx);
176 uma_zfree(newnfsnode_zone, np);
179 error = vfs_hash_insert(vp, hash, lkflags,
180 td, &nvp, newnfs_vncmpf, np->n_fhp);
185 /* vfs_hash_insert() vput()'s the losing vnode */
194 * Do the vrele(sp->s_dvp) as a separate task in order to avoid a
195 * deadlock because of a LOR when vrele() locks the directory vnode.
198 nfs_freesillyrename(void *arg, __unused int pending)
200 struct sillyrename *sp;
204 free(sp, M_NEWNFSREQ);
208 ncl_inactive(struct vop_inactive_args *ap)
211 struct sillyrename *sp;
212 struct vnode *vp = ap->a_vp;
217 if (NFS_ISV4(vp) && vp->v_type == VREG) {
219 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
220 * Close operations are delayed until now. Any dirty
221 * buffers/pages must be flushed before the close, so that the
222 * stateid is available for the writes.
224 if (vp->v_object != NULL) {
225 VM_OBJECT_LOCK(vp->v_object);
226 retv = vm_object_page_clean(vp->v_object, 0, 0,
228 VM_OBJECT_UNLOCK(vp->v_object);
232 (void)ncl_flush(vp, MNT_WAIT, NULL, ap->a_td, 1, 0);
233 (void)nfsrpc_close(vp, 1, ap->a_td);
237 mtx_lock(&np->n_mtx);
238 if (vp->v_type != VDIR) {
239 sp = np->n_sillyrename;
240 np->n_sillyrename = NULL;
244 mtx_unlock(&np->n_mtx);
245 (void) ncl_vinvalbuf(vp, 0, ap->a_td, 1);
247 * Remove the silly file that was rename'd earlier
249 ncl_removeit(sp, vp);
251 TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp);
252 taskqueue_enqueue(taskqueue_thread, &sp->s_task);
253 mtx_lock(&np->n_mtx);
255 np->n_flag &= NMODIFIED;
256 mtx_unlock(&np->n_mtx);
261 * Reclaim an nfsnode so that it can be used for other purposes.
264 ncl_reclaim(struct vop_reclaim_args *ap)
266 struct vnode *vp = ap->a_vp;
267 struct nfsnode *np = VTONFS(vp);
268 struct nfsdmap *dp, *dp2;
271 * If the NLM is running, give it a chance to abort pending
274 if (nfs_reclaim_p != NULL)
278 * Destroy the vm object and flush associated pages.
280 vnode_destroy_vobject(vp);
282 if (NFS_ISV4(vp) && vp->v_type == VREG)
284 * We can now safely close any remaining NFSv4 Opens for
285 * this file. Most opens will have already been closed by
286 * ncl_inactive(), but there are cases where it is not
287 * called, so we need to do it again here.
289 (void) nfsrpc_close(vp, 1, ap->a_td);
294 * Call nfscl_reclaimnode() to save attributes in the delegation,
297 if (vp->v_type == VREG)
298 nfscl_reclaimnode(vp);
301 * Free up any directory cookie structures and
302 * large file handle structures that might be associated with
305 if (vp->v_type == VDIR) {
306 dp = LIST_FIRST(&np->n_cookies);
309 dp = LIST_NEXT(dp, ndm_list);
310 FREE((caddr_t)dp2, M_NFSDIROFF);
313 if (np->n_writecred != NULL)
314 crfree(np->n_writecred);
315 FREE((caddr_t)np->n_fhp, M_NFSFH);
316 if (np->n_v4 != NULL)
317 FREE((caddr_t)np->n_v4, M_NFSV4NODE);
318 mtx_destroy(&np->n_mtx);
319 uma_zfree(newnfsnode_zone, vp->v_data);
325 * Invalidate both the access and attribute caches for this vnode.
328 ncl_invalcaches(struct vnode *vp)
330 struct nfsnode *np = VTONFS(vp);
333 mtx_lock(&np->n_mtx);
334 for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
335 np->n_accesscache[i].stamp = 0;
336 KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
338 KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
339 mtx_unlock(&np->n_mtx);