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