xref: /openbsd/sys/nfs/nfs_node.c (revision 73471bf0)
1 /*	$OpenBSD: nfs_node.c,v 1.74 2021/10/20 06:35:39 semarie Exp $	*/
2 /*	$NetBSD: nfs_node.c,v 1.16 1996/02/18 11:53:42 fvdl Exp $	*/
3 
4 /*
5  * Copyright (c) 1989, 1993
6  *	The Regents of the University of California.  All rights reserved.
7  *
8  * This code is derived from software contributed to Berkeley by
9  * Rick Macklem at The University of Guelph.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. Neither the name of the University nor the names of its contributors
20  *    may be used to endorse or promote products derived from this software
21  *    without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  *	@(#)nfs_node.c	8.6 (Berkeley) 5/22/95
36  */
37 
38 
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/timeout.h>
42 #include <sys/mount.h>
43 #include <sys/namei.h>
44 #include <sys/vnode.h>
45 #include <sys/lock.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #include <sys/pool.h>
49 #include <sys/rwlock.h>
50 #include <sys/queue.h>
51 
52 #include <nfs/rpcv2.h>
53 #include <nfs/nfsproto.h>
54 #include <nfs/nfsnode.h>
55 #include <nfs/nfsmount.h>
56 #include <nfs/nfs_var.h>
57 
58 struct pool nfs_node_pool;
59 extern int prtactive;
60 
61 /* XXX */
62 extern const struct vops nfs_vops;
63 
64 /* filehandle to node lookup. */
65 static __inline int
66 nfsnode_cmp(const struct nfsnode *a, const struct nfsnode *b)
67 {
68 	if (a->n_fhsize != b->n_fhsize)
69 		return (a->n_fhsize - b->n_fhsize);
70 	return (memcmp(a->n_fhp, b->n_fhp, a->n_fhsize));
71 }
72 
73 RBT_PROTOTYPE(nfs_nodetree, nfsnode, n_entry, nfsnode_cmp);
74 RBT_GENERATE(nfs_nodetree, nfsnode, n_entry, nfsnode_cmp);
75 
76 void
77 nfs_ninit(struct nfsmount *nmp)
78 {
79 	RBT_INIT(nfs_nodetree, &nmp->nm_ntree);
80 }
81 
82 /*
83  * Look up a vnode/nfsnode by file handle and store the pointer in *npp.
84  * Callers must check for mount points!!
85  * An error number is returned.
86  */
87 int
88 nfs_nget(struct mount *mnt, nfsfh_t *fh, int fhsize, struct nfsnode **npp)
89 {
90 	struct nfsmount		*nmp;
91 	struct nfsnode		*np, find, *np2;
92 	struct vnode		*vp, *nvp;
93 	int			 error;
94 
95 	nmp = VFSTONFS(mnt);
96 
97 loop:
98 	find.n_fhp = fh;
99 	find.n_fhsize = fhsize;
100 	np = RBT_FIND(nfs_nodetree, &nmp->nm_ntree, &find);
101 	if (np != NULL) {
102 		vp = NFSTOV(np);
103 		error = vget(vp, LK_EXCLUSIVE);
104 		if (error)
105 			goto loop;
106 		*npp = np;
107 		return (0);
108 	}
109 
110 	/*
111 	 * getnewvnode() could recycle a vnode, potentially formerly
112 	 * owned by NFS. This will cause a VOP_RECLAIM() to happen,
113 	 * which will cause recursive locking, so we unlock before
114 	 * calling getnewvnode() lock again afterwards, but must check
115 	 * to see if this nfsnode has been added while we did not hold
116 	 * the lock.
117 	 */
118 	error = getnewvnode(VT_NFS, mnt, &nfs_vops, &nvp);
119 	/* note that we don't have this vnode set up completely yet */
120 	if (error) {
121 		*npp = NULL;
122 		return (error);
123 	}
124 	nvp->v_flag |= VLARVAL;
125 	np = pool_get(&nfs_node_pool, PR_WAITOK | PR_ZERO);
126 	/*
127 	 * getnewvnode() and pool_get() can sleep, check for race.
128 	 */
129 	if (RBT_FIND(nfs_nodetree, &nmp->nm_ntree, &find) != NULL) {
130 		pool_put(&nfs_node_pool, np);
131 		vgone(nvp);
132 		goto loop;
133 	}
134 
135 	vp = nvp;
136 #ifdef VFSLCKDEBUG
137 	vp->v_flag |= VLOCKSWORK;
138 #endif
139 	rrw_init_flags(&np->n_lock, "nfsnode", RWL_DUPOK | RWL_IS_VNODE);
140 	vp->v_data = np;
141 	/* we now have an nfsnode on this vnode */
142 	vp->v_flag &= ~VLARVAL;
143 	np->n_vnode = vp;
144 	rw_init(&np->n_commitlock, "nfs_commitlk");
145 	np->n_fhp = &np->n_fh;
146 	bcopy(fh, np->n_fhp, fhsize);
147 	np->n_fhsize = fhsize;
148 	/* lock the nfsnode, then put it on the rbtree */
149 	VOP_LOCK(vp, LK_EXCLUSIVE);
150 	np2 = RBT_INSERT(nfs_nodetree, &nmp->nm_ntree, np);
151 	KASSERT(np2 == NULL);
152 	np->n_accstamp = -1;
153 	*npp = np;
154 
155 	return (0);
156 }
157 
158 int
159 nfs_inactive(void *v)
160 {
161 	struct vop_inactive_args	*ap = v;
162 	struct nfsnode			*np;
163 	struct sillyrename		*sp;
164 
165 #ifdef DIAGNOSTIC
166 	if (prtactive && ap->a_vp->v_usecount != 0)
167 		vprint("nfs_inactive: pushing active", ap->a_vp);
168 #endif
169 	if (ap->a_vp->v_flag & VLARVAL)
170 		/*
171 		 * vnode was incompletely set up, just return
172 		 * as we are throwing it away.
173 		 */
174 		return(0);
175 #ifdef DIAGNOSTIC
176 	if (ap->a_vp->v_data == NULL)
177 		panic("NULL v_data (no nfsnode set up?) in vnode %p",
178 		    ap->a_vp);
179 #endif
180 	np = VTONFS(ap->a_vp);
181 	if (ap->a_vp->v_type != VDIR) {
182 		sp = np->n_sillyrename;
183 		np->n_sillyrename = NULL;
184 	} else
185 		sp = NULL;
186 	if (sp) {
187 		/*
188 		 * Remove the silly file that was rename'd earlier
189 		 */
190 		nfs_vinvalbuf(ap->a_vp, 0, sp->s_cred, curproc);
191 		vn_lock(sp->s_dvp, LK_EXCLUSIVE | LK_RETRY);
192 		nfs_removeit(sp);
193 		crfree(sp->s_cred);
194 		vput(sp->s_dvp);
195 		free(sp, M_NFSREQ, sizeof(*sp));
196 	}
197 	np->n_flag &= (NMODIFIED | NFLUSHINPROG | NFLUSHWANT);
198 
199 	VOP_UNLOCK(ap->a_vp);
200 	return (0);
201 }
202 
203 /*
204  * Reclaim an nfsnode so that it can be used for other purposes.
205  */
206 int
207 nfs_reclaim(void *v)
208 {
209 	struct vop_reclaim_args	*ap = v;
210 	struct vnode		*vp = ap->a_vp;
211 	struct nfsmount		*nmp;
212 	struct nfsnode		*np = VTONFS(vp);
213 
214 #ifdef DIAGNOSTIC
215 	if (prtactive && vp->v_usecount != 0)
216 		vprint("nfs_reclaim: pushing active", vp);
217 #endif
218 	if (ap->a_vp->v_flag & VLARVAL)
219 		/*
220 		 * vnode was incompletely set up, just return
221 		 * as we are throwing it away.
222 		 */
223 		return(0);
224 #ifdef DIAGNOSTIC
225 	if (ap->a_vp->v_data == NULL)
226 		panic("NULL v_data (no nfsnode set up?) in vnode %p",
227 		    ap->a_vp);
228 #endif
229 	nmp = VFSTONFS(vp->v_mount);
230 	RBT_REMOVE(nfs_nodetree, &nmp->nm_ntree, np);
231 
232 	if (np->n_rcred)
233 		crfree(np->n_rcred);
234 	if (np->n_wcred)
235 		crfree(np->n_wcred);
236 
237 	cache_purge(vp);
238 	pool_put(&nfs_node_pool, vp->v_data);
239 	vp->v_data = NULL;
240 
241 	return (0);
242 }
243