xref: /freebsd/sys/fs/nfsclient/nfs_clnode.c (revision 1bee2ec756f2ea5255f9f68dd58c1ceae1a2f56c)
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/vnode.h>
51 
52 #include <vm/uma.h>
53 
54 #include <fs/nfs/nfsport.h>
55 #include <fs/nfsclient/nfsnode.h>
56 #include <fs/nfsclient/nfsmount.h>
57 #include <fs/nfsclient/nfs.h>
58 #include <fs/nfsclient/nfs_kdtrace.h>
59 
60 #include <nfs/nfs_lock.h>
61 
62 extern struct vop_vector newnfs_vnodeops;
63 extern struct buf_ops buf_ops_newnfs;
64 MALLOC_DECLARE(M_NEWNFSREQ);
65 
66 uma_zone_t newnfsnode_zone;
67 
68 void
69 ncl_nhinit(void)
70 {
71 
72 	newnfsnode_zone = uma_zcreate("NCLNODE", sizeof(struct nfsnode), NULL,
73 	    NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
74 }
75 
76 void
77 ncl_nhuninit(void)
78 {
79 	uma_zdestroy(newnfsnode_zone);
80 }
81 
82 /*
83  * ONLY USED FOR THE ROOT DIRECTORY. nfscl_nget() does the rest. If this
84  * function is going to be used to get Regular Files, code must be added
85  * to fill in the "struct nfsv4node".
86  * Look up a vnode/nfsnode by file handle.
87  * Callers must check for mount points!!
88  * In all cases, a pointer to a
89  * nfsnode structure is returned.
90  */
91 int
92 ncl_nget(struct mount *mntp, u_int8_t *fhp, int fhsize, struct nfsnode **npp,
93     int lkflags)
94 {
95 	struct thread *td = curthread;	/* XXX */
96 	struct nfsnode *np;
97 	struct vnode *vp;
98 	struct vnode *nvp;
99 	int error;
100 	u_int hash;
101 	struct nfsmount *nmp;
102 	struct nfsfh *nfhp;
103 
104 	nmp = VFSTONFS(mntp);
105 	*npp = NULL;
106 
107 	hash = fnv_32_buf(fhp, fhsize, FNV1_32_INIT);
108 
109 	MALLOC(nfhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize,
110 	    M_NFSFH, M_WAITOK);
111 	bcopy(fhp, &nfhp->nfh_fh[0], fhsize);
112 	nfhp->nfh_len = fhsize;
113 	error = vfs_hash_get(mntp, hash, lkflags,
114 	    td, &nvp, newnfs_vncmpf, nfhp);
115 	FREE(nfhp, M_NFSFH);
116 	if (error)
117 		return (error);
118 	if (nvp != NULL) {
119 		*npp = VTONFS(nvp);
120 		return (0);
121 	}
122 
123 	/*
124 	 * Allocate before getnewvnode since doing so afterward
125 	 * might cause a bogus v_data pointer to get dereferenced
126 	 * elsewhere if zalloc should block.
127 	 */
128 	np = uma_zalloc(newnfsnode_zone, M_WAITOK | M_ZERO);
129 
130 	error = getnewvnode("newnfs", mntp, &newnfs_vnodeops, &nvp);
131 	if (error) {
132 		uma_zfree(newnfsnode_zone, np);
133 		return (error);
134 	}
135 	vp = nvp;
136 	vp->v_bufobj.bo_ops = &buf_ops_newnfs;
137 	vp->v_data = np;
138 	np->n_vnode = vp;
139 	/*
140 	 * Initialize the mutex even if the vnode is going to be a loser.
141 	 * This simplifies the logic in reclaim, which can then unconditionally
142 	 * destroy the mutex (in the case of the loser, or if hash_insert
143 	 * happened to return an error no special casing is needed).
144 	 */
145 	mtx_init(&np->n_mtx, "NEWNFSnode lock", NULL, MTX_DEF | MTX_DUPOK);
146 	/*
147 	 * NFS supports recursive and shared locking.
148 	 */
149 	lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
150 	VN_LOCK_AREC(vp);
151 	VN_LOCK_ASHARE(vp);
152 	/*
153 	 * Are we getting the root? If so, make sure the vnode flags
154 	 * are correct
155 	 */
156 	if ((fhsize == nmp->nm_fhsize) &&
157 	    !bcmp(fhp, nmp->nm_fh, fhsize)) {
158 		if (vp->v_type == VNON)
159 			vp->v_type = VDIR;
160 		vp->v_vflag |= VV_ROOT;
161 	}
162 
163 	MALLOC(np->n_fhp, struct nfsfh *, sizeof (struct nfsfh) + fhsize,
164 	    M_NFSFH, M_WAITOK);
165 	bcopy(fhp, np->n_fhp->nfh_fh, fhsize);
166 	np->n_fhp->nfh_len = fhsize;
167 	error = insmntque(vp, mntp);
168 	if (error != 0) {
169 		*npp = NULL;
170 		FREE((caddr_t)np->n_fhp, M_NFSFH);
171 		mtx_destroy(&np->n_mtx);
172 		uma_zfree(newnfsnode_zone, np);
173 		return (error);
174 	}
175 	error = vfs_hash_insert(vp, hash, lkflags,
176 	    td, &nvp, newnfs_vncmpf, np->n_fhp);
177 	if (error)
178 		return (error);
179 	if (nvp != NULL) {
180 		*npp = VTONFS(nvp);
181 		/* vfs_hash_insert() vput()'s the losing vnode */
182 		return (0);
183 	}
184 	*npp = np;
185 
186 	return (0);
187 }
188 
189 int
190 ncl_inactive(struct vop_inactive_args *ap)
191 {
192 	struct nfsnode *np;
193 	struct sillyrename *sp;
194 	struct vnode *vp = ap->a_vp;
195 
196 	np = VTONFS(vp);
197 
198 	if (NFS_ISV4(vp) && vp->v_type == VREG) {
199 		/*
200 		 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
201 		 * Close operations are delayed until now. Any dirty buffers
202 		 * must be flushed before the close, so that the stateid is
203 		 * available for the writes.
204 		 */
205 		(void) ncl_flush(vp, MNT_WAIT, NULL, ap->a_td, 1, 0);
206 		(void) nfsrpc_close(vp, 1, ap->a_td);
207 	}
208 
209 	mtx_lock(&np->n_mtx);
210 	if (vp->v_type != VDIR) {
211 		sp = np->n_sillyrename;
212 		np->n_sillyrename = NULL;
213 	} else
214 		sp = NULL;
215 	if (sp) {
216 		mtx_unlock(&np->n_mtx);
217 		(void) ncl_vinvalbuf(vp, 0, ap->a_td, 1);
218 		/*
219 		 * Remove the silly file that was rename'd earlier
220 		 */
221 		ncl_removeit(sp, vp);
222 		crfree(sp->s_cred);
223 		vrele(sp->s_dvp);
224 		FREE((caddr_t)sp, M_NEWNFSREQ);
225 		mtx_lock(&np->n_mtx);
226 	}
227 	np->n_flag &= NMODIFIED;
228 	mtx_unlock(&np->n_mtx);
229 	return (0);
230 }
231 
232 /*
233  * Reclaim an nfsnode so that it can be used for other purposes.
234  */
235 int
236 ncl_reclaim(struct vop_reclaim_args *ap)
237 {
238 	struct vnode *vp = ap->a_vp;
239 	struct nfsnode *np = VTONFS(vp);
240 	struct nfsdmap *dp, *dp2;
241 
242 	if (NFS_ISV4(vp) && vp->v_type == VREG)
243 		/*
244 		 * Since mmap()'d files do I/O after VOP_CLOSE(), the NFSv4
245 		 * Close operations are delayed until ncl_inactive().
246 		 * However, since VOP_INACTIVE() is not guaranteed to be
247 		 * called, we need to do it again here.
248 		 */
249 		(void) nfsrpc_close(vp, 1, ap->a_td);
250 
251 	/*
252 	 * If the NLM is running, give it a chance to abort pending
253 	 * locks.
254 	 */
255 	if (nfs_reclaim_p != NULL)
256 		nfs_reclaim_p(ap);
257 
258 	/*
259 	 * Destroy the vm object and flush associated pages.
260 	 */
261 	vnode_destroy_vobject(vp);
262 
263 	vfs_hash_remove(vp);
264 
265 	/*
266 	 * Call nfscl_reclaimnode() to save attributes in the delegation,
267 	 * as required.
268 	 */
269 	if (vp->v_type == VREG)
270 		nfscl_reclaimnode(vp);
271 
272 	/*
273 	 * Free up any directory cookie structures and
274 	 * large file handle structures that might be associated with
275 	 * this nfs node.
276 	 */
277 	if (vp->v_type == VDIR) {
278 		dp = LIST_FIRST(&np->n_cookies);
279 		while (dp) {
280 			dp2 = dp;
281 			dp = LIST_NEXT(dp, ndm_list);
282 			FREE((caddr_t)dp2, M_NFSDIROFF);
283 		}
284 	}
285 	FREE((caddr_t)np->n_fhp, M_NFSFH);
286 	if (np->n_v4 != NULL)
287 		FREE((caddr_t)np->n_v4, M_NFSV4NODE);
288 	mtx_destroy(&np->n_mtx);
289 	uma_zfree(newnfsnode_zone, vp->v_data);
290 	vp->v_data = NULL;
291 	return (0);
292 }
293 
294 /*
295  * Invalidate both the access and attribute caches for this vnode.
296  */
297 void
298 ncl_invalcaches(struct vnode *vp)
299 {
300 	struct nfsnode *np = VTONFS(vp);
301 	int i;
302 
303 	mtx_lock(&np->n_mtx);
304 	for (i = 0; i < NFS_ACCESSCACHESIZE; i++)
305 		np->n_accesscache[i].stamp = 0;
306 	KDTRACE_NFS_ACCESSCACHE_FLUSH_DONE(vp);
307 	np->n_attrstamp = 0;
308 	KDTRACE_NFS_ATTRCACHE_FLUSH_DONE(vp);
309 	mtx_unlock(&np->n_mtx);
310 }
311 
312