xref: /freebsd/sys/fs/nfsclient/nfs_clnode.c (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
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  *	from nfs_node.c	8.6 (Berkeley) 5/22/95
33  */
34 
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37 
38 #include "opt_kdtrace.h"
39 
40 #include <sys/param.h>
41 #include <sys/systm.h>
42 #include <sys/fcntl.h>
43 #include <sys/lock.h>
44 #include <sys/malloc.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/taskqueue.h>
51 #include <sys/vnode.h>
52 
53 #include <vm/uma.h>
54 
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>
60 
61 #include <nfs/nfs_lock.h>
62 
63 extern struct vop_vector newnfs_vnodeops;
64 extern struct buf_ops buf_ops_newnfs;
65 MALLOC_DECLARE(M_NEWNFSREQ);
66 
67 uma_zone_t newnfsnode_zone;
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 	MALLOC(nfhp, struct nfsfh *, 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 
126 	/*
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.
130 	 */
131 	np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO);
132 
133 	error = getnewvnode("newnfs", mntp, &newnfs_vnodeops, &nvp);
134 	if (error) {
135 		uma_zfree(newnfsnode_zone, np);
136 		return (error);
137 	}
138 	vp = nvp;
139 	vp->v_bufobj.bo_ops = &buf_ops_newnfs;
140 	vp->v_data = np;
141 	np->n_vnode = vp;
142 	/*
143 	 * Initialize the mutex even if the vnode is going to be a loser.
144 	 * This simplifies the logic in reclaim, which can then unconditionally
145 	 * destroy the mutex (in the case of the loser, or if hash_insert
146 	 * happened to return an error no special casing is needed).
147 	 */
148 	mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK);
149 	/*
150 	 * NFS supports recursive and shared locking.
151 	 */
152 	lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
153 	VN_LOCK_AREC(vp);
154 	VN_LOCK_ASHARE(vp);
155 	/*
156 	 * Are we getting the root? If so, make sure the vnode flags
157 	 * are correct
158 	 */
159 	if ((fhsize == nmp->nm_fhsize) &&
160 	    !bcmp(fhp, nmp->nm_fh, fhsize)) {
161 		if (vp->v_type == VNON)
162 			vp->v_type = VDIR;
163 		vp->v_vflag |= VV_ROOT;
164 	}
165 
166 	MALLOC(np->n_fhp, struct nfsfh *, 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((caddr_t)np->n_fhp, M_NFSFH);
174 		mtx_destroy(&np->n_mtx);
175 		uma_zfree(newnfsnode_zone, np);
176 		return (error);
177 	}
178 	error = vfs_hash_insert(vp, hash, lkflags,
179 	    td, &nvp, newnfs_vncmpf, np->n_fhp);
180 	if (error)
181 		return (error);
182 	if (nvp != NULL) {
183 		*npp = VTONFS(nvp);
184 		/* vfs_hash_insert() vput()'s the losing vnode */
185 		return (0);
186 	}
187 	*npp = np;
188 
189 	return (0);
190 }
191 
192 /*
193  * Do the vrele(sp->s_dvp) as a separate task in order to avoid a
194  * deadlock because of a LOR when vrele() locks the directory vnode.
195  */
196 static void
197 nfs_freesillyrename(void *arg, __unused int pending)
198 {
199 	struct sillyrename *sp;
200 
201 	sp = arg;
202 	vrele(sp->s_dvp);
203 	free(sp, M_NEWNFSREQ);
204 }
205 
206 int
207 ncl_inactive(struct vop_inactive_args *ap)
208 {
209 	struct nfsnode *np;
210 	struct sillyrename *sp;
211 	struct vnode *vp = ap->a_vp;
212 
213 	np = VTONFS(vp);
214 
215 	if (NFS_ISV4(vp) && vp->v_type == VREG) {
216 		/*
217 		 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
218 		 * Close operations are delayed until now. Any dirty buffers
219 		 * must be flushed before the close, so that the stateid is
220 		 * available for the writes.
221 		 */
222 		(void) ncl_flush(vp, MNT_WAIT, NULL, ap->a_td, 1, 0);
223 		(void) nfsrpc_close(vp, 1, ap->a_td);
224 	}
225 
226 	mtx_lock(&np->n_mtx);
227 	if (vp->v_type != VDIR) {
228 		sp = np->n_sillyrename;
229 		np->n_sillyrename = NULL;
230 	} else
231 		sp = NULL;
232 	if (sp) {
233 		mtx_unlock(&np->n_mtx);
234 		(void) ncl_vinvalbuf(vp, 0, ap->a_td, 1);
235 		/*
236 		 * Remove the silly file that was rename'd earlier
237 		 */
238 		ncl_removeit(sp, vp);
239 		crfree(sp->s_cred);
240 		TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp);
241 		taskqueue_enqueue(taskqueue_thread, &sp->s_task);
242 		mtx_lock(&np->n_mtx);
243 	}
244 	np->n_flag &= NMODIFIED;
245 	mtx_unlock(&np->n_mtx);
246 	return (0);
247 }
248 
249 /*
250  * Reclaim an nfsnode so that it can be used for other purposes.
251  */
252 int
253 ncl_reclaim(struct vop_reclaim_args *ap)
254 {
255 	struct vnode *vp = ap->a_vp;
256 	struct nfsnode *np = VTONFS(vp);
257 	struct nfsdmap *dp, *dp2;
258 
259 	if (NFS_ISV4(vp) && vp->v_type == VREG)
260 		/*
261 		 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
262 		 * Close operations are delayed until ncl_inactive().
263 		 * However, since VOP_INACTIVE() is not guaranteed to be
264 		 * called, we need to do it again here.
265 		 */
266 		(void) nfsrpc_close(vp, 1, ap->a_td);
267 
268 	/*
269 	 * If the NLM is running, give it a chance to abort pending
270 	 * locks.
271 	 */
272 	if (nfs_reclaim_p != NULL)
273 		nfs_reclaim_p(ap);
274 
275 	/*
276 	 * Destroy the vm object and flush associated pages.
277 	 */
278 	vnode_destroy_vobject(vp);
279 
280 	vfs_hash_remove(vp);
281 
282 	/*
283 	 * Call nfscl_reclaimnode() to save attributes in the delegation,
284 	 * as required.
285 	 */
286 	if (vp->v_type == VREG)
287 		nfscl_reclaimnode(vp);
288 
289 	/*
290 	 * Free up any directory cookie structures and
291 	 * large file handle structures that might be associated with
292 	 * this nfs node.
293 	 */
294 	if (vp->v_type == VDIR) {
295 		dp = LIST_FIRST(&np->n_cookies);
296 		while (dp) {
297 			dp2 = dp;
298 			dp = LIST_NEXT(dp, ndm_list);
299 			FREE((caddr_t)dp2, M_NFSDIROFF);
300 		}
301 	}
302 	FREE((caddr_t)np->n_fhp, M_NFSFH);
303 	if (np->n_v4 != NULL)
304 		FREE((caddr_t)np->n_v4, M_NFSV4NODE);
305 	mtx_destroy(&np->n_mtx);
306 	uma_zfree(newnfsnode_zone, vp->v_data);
307 	vp->v_data = NULL;
308 	return (0);
309 }
310 
311 /*
312  * Invalidate both the access and attribute caches for this vnode.
313  */
314 void
315 ncl_invalcaches(struct vnode *vp)
316 {
317 	struct nfsnode *np = VTONFS(vp);
318 	int i;
319 
320 	mtx_lock(&np->n_mtx);
321 	for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
322 		np->n_accesscache[i].stamp = 0;
323 	KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
324 	np->n_attrstamp = 0;
325 	KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
326 	mtx_unlock(&np->n_mtx);
327 }
328 
329