xref: /netbsd-src/sys/nfs/nfs_node.c (revision c9496f6b604074a9451a67df576a5b423068e71e)
1 /*	$NetBSD: nfs_node.c,v 1.122 2017/05/26 14:34:20 riastradh Exp $	*/
2 
3 /*
4  * Copyright (c) 1989, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Rick Macklem at The University of Guelph.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)nfs_node.c	8.6 (Berkeley) 5/22/95
35  */
36 
37 #include <sys/cdefs.h>
38 __KERNEL_RCSID(0, "$NetBSD: nfs_node.c,v 1.122 2017/05/26 14:34:20 riastradh Exp $");
39 
40 #ifdef _KERNEL_OPT
41 #include "opt_nfs.h"
42 #endif
43 
44 #include <sys/param.h>
45 #include <sys/systm.h>
46 #include <sys/proc.h>
47 #include <sys/mount.h>
48 #include <sys/namei.h>
49 #include <sys/vnode.h>
50 #include <sys/kernel.h>
51 #include <sys/pool.h>
52 #include <sys/lock.h>
53 #include <sys/hash.h>
54 #include <sys/kauth.h>
55 
56 #include <nfs/rpcv2.h>
57 #include <nfs/nfsproto.h>
58 #include <nfs/nfs.h>
59 #include <nfs/nfsnode.h>
60 #include <nfs/nfsmount.h>
61 #include <nfs/nfs_var.h>
62 
63 struct pool nfs_node_pool;
64 struct pool nfs_vattr_pool;
65 static struct workqueue *nfs_sillyworkq;
66 
67 static void nfs_gop_size(struct vnode *, off_t, off_t *, int);
68 static int nfs_gop_alloc(struct vnode *, off_t, off_t, int, kauth_cred_t);
69 static int nfs_gop_write(struct vnode *, struct vm_page **, int, int);
70 static void nfs_sillyworker(struct work *, void *);
71 
72 static const struct genfs_ops nfs_genfsops = {
73 	.gop_size = nfs_gop_size,
74 	.gop_alloc = nfs_gop_alloc,
75 	.gop_write = nfs_gop_write,
76 };
77 
78 /*
79  * Reinitialize inode hash table.
80  */
81 void
82 nfs_node_init(void)
83 {
84 
85 	pool_init(&nfs_node_pool, sizeof(struct nfsnode), 0, 0, 0, "nfsnodepl",
86 	    &pool_allocator_nointr, IPL_NONE);
87 	pool_init(&nfs_vattr_pool, sizeof(struct vattr), 0, 0, 0, "nfsvapl",
88 	    &pool_allocator_nointr, IPL_NONE);
89 	if (workqueue_create(&nfs_sillyworkq, "nfssilly", nfs_sillyworker,
90 	    NULL, PRI_NONE, IPL_NONE, 0) != 0) {
91 	    	panic("nfs_node_init");
92 	}
93 }
94 
95 /*
96  * Free resources previously allocated in nfs_node_reinit().
97  */
98 void
99 nfs_node_done(void)
100 {
101 
102 	pool_destroy(&nfs_node_pool);
103 	pool_destroy(&nfs_vattr_pool);
104 	workqueue_destroy(nfs_sillyworkq);
105 }
106 
107 /*
108  * Initialize this vnode / nfs node pair.
109  * Caller assures no other thread will try to load this node.
110  */
111 int
112 nfs_loadvnode(struct mount *mp, struct vnode *vp,
113     const void *key, size_t key_len, const void **new_key)
114 {
115 	int fhsize = key_len;
116 	const nfsfh_t *fhp = key;
117 	struct nfsnode *np;
118 
119 	/* Aloocate and initialize the nfsnode. */
120 	np = pool_get(&nfs_node_pool, PR_WAITOK);
121 	memset(np, 0, sizeof *np);
122 	if (fhsize > NFS_SMALLFH) {
123 		np->n_fhp = kmem_alloc(fhsize, KM_SLEEP);
124 	} else
125 		np->n_fhp = &np->n_fh;
126 	vp->v_tag = VT_NFS;
127 	vp->v_type = VNON;
128 	vp->v_op = nfsv2_vnodeop_p;
129 	vp->v_data = np;
130 	memcpy(np->n_fhp, fhp, fhsize);
131 	np->n_fhsize = fhsize;
132 	np->n_accstamp = -1;
133 	np->n_vattr = pool_get(&nfs_vattr_pool, PR_WAITOK);
134 	np->n_vnode = vp;
135 
136 	/* Initialize genfs node. */
137 	genfs_node_init(vp, &nfs_genfsops);
138 	/*
139 	 * Initalize read/write creds to useful values. VOP_OPEN will
140 	 * overwrite these.
141 	 */
142 	np->n_rcred = curlwp->l_cred;
143 	kauth_cred_hold(np->n_rcred);
144 	np->n_wcred = curlwp->l_cred;
145 	kauth_cred_hold(np->n_wcred);
146 	NFS_INVALIDATE_ATTRCACHE(np);
147 	uvm_vnp_setsize(vp, 0);
148 	*new_key = np->n_fhp;
149 	return 0;
150 }
151 
152 /*
153  * Look up a vnode/nfsnode by file handle.
154  * Callers must check for mount points!!
155  * In all cases, a pointer to a
156  * nfsnode structure is returned.
157  */
158 int
159 nfs_nget1(struct mount *mntp, nfsfh_t *fhp, int fhsize, struct nfsnode **npp,
160     int lkflags)
161 {
162 	int error;
163 	struct vnode *vp;
164 
165 	error = vcache_get(mntp, fhp, fhsize, &vp);
166 	if (error)
167 		return error;
168 	error = vn_lock(vp, LK_EXCLUSIVE | lkflags);
169 	if (error) {
170 		vrele(vp);
171 		return error;
172 	}
173 	*npp = VTONFS(vp);
174 	return 0;
175 }
176 
177 int
178 nfs_inactive(void *v)
179 {
180 	struct vop_inactive_v2_args /* {
181 		struct vnode *a_vp;
182 		bool *a_recycle;
183 	} */ *ap = v;
184 	struct nfsnode *np;
185 	struct sillyrename *sp;
186 	struct vnode *vp = ap->a_vp;
187 
188 	np = VTONFS(vp);
189 	if (vp->v_type != VDIR) {
190 		sp = np->n_sillyrename;
191 		np->n_sillyrename = (struct sillyrename *)0;
192 	} else
193 		sp = NULL;
194 	if (sp != NULL)
195 		nfs_vinvalbuf(vp, 0, sp->s_cred, curlwp, 1);
196 	*ap->a_recycle = (np->n_flag & NREMOVED) != 0;
197 	np->n_flag &=
198 	    (NMODIFIED | NFLUSHINPROG | NFLUSHWANT | NEOFVALID | NTRUNCDELAYED);
199 
200 	if (vp->v_type == VDIR && np->n_dircache)
201 		nfs_invaldircache(vp,
202 		    NFS_INVALDIRCACHE_FORCE | NFS_INVALDIRCACHE_KEEPEOF);
203 
204 	if (sp != NULL) {
205 		workqueue_enqueue(nfs_sillyworkq, &sp->s_work, NULL);
206 	}
207 
208 	return (0);
209 }
210 
211 /*
212  * Reclaim an nfsnode so that it can be used for other purposes.
213  */
214 int
215 nfs_reclaim(void *v)
216 {
217 	struct vop_reclaim_v2_args /* {
218 		struct vnode *a_vp;
219 	} */ *ap = v;
220 	struct vnode *vp = ap->a_vp;
221 	struct nfsnode *np = VTONFS(vp);
222 
223 	VOP_UNLOCK(vp);
224 
225 	/*
226 	 * Free up any directory cookie structures and
227 	 * large file handle structures that might be associated with
228 	 * this nfs node.
229 	 */
230 	if (vp->v_type == VDIR && np->n_dircache != NULL) {
231 		nfs_invaldircache(vp, NFS_INVALDIRCACHE_FORCE);
232 		hashdone(np->n_dircache, HASH_LIST, nfsdirhashmask);
233 	}
234 	KASSERT(np->n_dirgens == NULL);
235 
236 	if (np->n_fhsize > NFS_SMALLFH)
237 		kmem_free(np->n_fhp, np->n_fhsize);
238 
239 	pool_put(&nfs_vattr_pool, np->n_vattr);
240 	if (np->n_rcred)
241 		kauth_cred_free(np->n_rcred);
242 
243 	if (np->n_wcred)
244 		kauth_cred_free(np->n_wcred);
245 
246 	if (vp->v_type == VREG) {
247 		mutex_destroy(&np->n_commitlock);
248 	}
249 	genfs_node_destroy(vp);
250 	pool_put(&nfs_node_pool, np);
251 	vp->v_data = NULL;
252 	return (0);
253 }
254 
255 void
256 nfs_gop_size(struct vnode *vp, off_t size, off_t *eobp, int flags)
257 {
258 
259 	*eobp = MAX(size, vp->v_size);
260 }
261 
262 int
263 nfs_gop_alloc(struct vnode *vp, off_t off, off_t len, int flags,
264     kauth_cred_t cred)
265 {
266 
267 	return 0;
268 }
269 
270 int
271 nfs_gop_write(struct vnode *vp, struct vm_page **pgs, int npages, int flags)
272 {
273 	int i;
274 
275 	mutex_enter(vp->v_interlock);
276 	for (i = 0; i < npages; i++) {
277 		pmap_page_protect(pgs[i], VM_PROT_READ);
278 	}
279 	mutex_exit(vp->v_interlock);
280 
281 	return genfs_gop_write(vp, pgs, npages, flags);
282 }
283 
284 /*
285  * Remove a silly file that was rename'd earlier
286  */
287 static void
288 nfs_sillyworker(struct work *work, void *arg)
289 {
290 	struct sillyrename *sp;
291 	int error;
292 
293 	sp = (struct sillyrename *)work;
294 	error = vn_lock(sp->s_dvp, LK_EXCLUSIVE);
295 	if (error || sp->s_dvp->v_data == NULL) {
296 		/* XXX should recover */
297 		printf("%s: vp=%p error=%d\n", __func__, sp->s_dvp, error);
298 		if (error == 0) {
299 			vput(sp->s_dvp);
300 		} else {
301 			vrele(sp->s_dvp);
302 		}
303 	} else {
304 		nfs_removeit(sp);
305 		vput(sp->s_dvp);
306 	}
307 	kauth_cred_free(sp->s_cred);
308 	kmem_free(sp, sizeof(*sp));
309 }
310