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 *	@(#)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/fnv_hash.h>
42#include <sys/lock.h>
43#include <sys/malloc.h>
44#include <sys/mbuf.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 <nfs/nfsproto.h>
56#include <nfs/nfs_lock.h>
57#include <nfsclient/nfs.h>
58#include <nfsclient/nfsnode.h>
59#include <nfsclient/nfsmount.h>
60
61static uma_zone_t nfsnode_zone;
62
63static void	nfs_freesillyrename(void *arg, __unused int pending);
64
65#define TRUE	1
66#define	FALSE	0
67
68void
69nfs_nhinit(void)
70{
71
72	nfsnode_zone = uma_zcreate("NFSNODE", sizeof(struct nfsnode), NULL,
73	    NULL, NULL, NULL, UMA_ALIGN_PTR, 0);
74}
75
76void
77nfs_nhuninit(void)
78{
79	uma_zdestroy(nfsnode_zone);
80}
81
82struct nfs_vncmp {
83	int	fhsize;
84	void	*fh;
85};
86
87static int
88nfs_vncmpf(struct vnode *vp, void *arg)
89{
90	struct nfs_vncmp *a;
91	struct nfsnode *np;
92
93	a = arg;
94	np = VTONFS(vp);
95	return (bcmp(a->fh, np->n_fhp, a->fhsize));
96}
97
98/*
99 * Look up a vnode/nfsnode by file handle.
100 * Callers must check for mount points!!
101 * In all cases, a pointer to a
102 * nfsnode structure is returned.
103 */
104int
105nfs_nget(struct mount *mntp, nfsfh_t *fhp, int fhsize, struct nfsnode **npp, int flags)
106{
107	struct thread *td = curthread;	/* XXX */
108	struct nfsnode *np;
109	struct vnode *vp;
110	struct vnode *nvp;
111	int error;
112	u_int hash;
113	struct nfsmount *nmp;
114	struct nfs_vncmp ncmp;
115
116	nmp = VFSTONFS(mntp);
117	*npp = NULL;
118
119	hash = fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT);
120	ncmp.fhsize = fhsize;
121	ncmp.fh = fhp;
122
123	error = vfs_hash_get(mntp, hash, flags,
124	    td, &nvp, nfs_vncmpf, &ncmp);
125	if (error)
126		return (error);
127	if (nvp != NULL) {
128		*npp = VTONFS(nvp);
129		return (0);
130	}
131
132	/*
133	 * Allocate before getnewvnode since doing so afterward
134	 * might cause a bogus v_data pointer to get dereferenced
135	 * elsewhere if zalloc should block.
136	 */
137	np = uma_zalloc(nfsnode_zone, M_WAITOK | M_ZERO);
138
139	error = getnewvnode("nfs", mntp, &nfs_vnodeops, &nvp);
140	if (error) {
141		uma_zfree(nfsnode_zone, np);
142		return (error);
143	}
144	vp = nvp;
145	vp->v_bufobj.bo_ops = &buf_ops_nfs;
146	vp->v_data = np;
147	np->n_vnode = vp;
148	/*
149	 * Initialize the mutex even if the vnode is going to be a loser.
150	 * This simplifies the logic in reclaim, which can then unconditionally
151	 * destroy the mutex (in the case of the loser, or if hash_insert happened
152	 * to return an error no special casing is needed).
153	 */
154	mtx_init(&np->n_mtx, "NFSnode lock", NULL, MTX_DEF);
155	/*
156	 * NFS supports recursive and shared locking.
157	 */
158	lockmgr(vp->v_vnlock, LK_EXCLUSIVE | LK_NOWITNESS, NULL);
159	VN_LOCK_AREC(vp);
160	VN_LOCK_ASHARE(vp);
161	if (fhsize > NFS_SMALLFH) {
162		np->n_fhp = malloc(fhsize, M_NFSBIGFH, M_WAITOK);
163	} else
164		np->n_fhp = &np->n_fh;
165	bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
166	np->n_fhsize = fhsize;
167	error = insmntque(vp, mntp);
168	if (error != 0) {
169		*npp = NULL;
170		if (np->n_fhsize > NFS_SMALLFH) {
171			free((caddr_t)np->n_fhp, M_NFSBIGFH);
172		}
173		mtx_destroy(&np->n_mtx);
174		uma_zfree(nfsnode_zone, np);
175		return (error);
176	}
177	error = vfs_hash_insert(vp, hash, flags,
178	    td, &nvp, nfs_vncmpf, &ncmp);
179	if (error)
180		return (error);
181	if (nvp != NULL) {
182		*npp = VTONFS(nvp);
183		/* vfs_hash_insert() vput()'s the losing vnode */
184		return (0);
185	}
186	*npp = np;
187
188	return (0);
189}
190
191/*
192 * Do the vrele(sp->s_dvp) as a separate task in order to avoid a
193 * deadlock because of a LOR when vrele() locks the directory vnode.
194 */
195static void
196nfs_freesillyrename(void *arg, __unused int pending)
197{
198	struct sillyrename *sp;
199
200	sp = arg;
201	vrele(sp->s_dvp);
202	free(sp, M_NFSREQ);
203}
204
205int
206nfs_inactive(struct vop_inactive_args *ap)
207{
208	struct nfsnode *np;
209	struct sillyrename *sp;
210	struct thread *td = curthread;	/* XXX */
211
212	np = VTONFS(ap->a_vp);
213	mtx_lock(&np->n_mtx);
214	if (ap->a_vp->v_type != VDIR) {
215		sp = np->n_sillyrename;
216		np->n_sillyrename = NULL;
217	} else
218		sp = NULL;
219	if (sp) {
220		mtx_unlock(&np->n_mtx);
221		(void)nfs_vinvalbuf(ap->a_vp, 0, td, 1);
222		/*
223		 * Remove the silly file that was rename'd earlier
224		 */
225		(sp->s_removeit)(sp);
226		crfree(sp->s_cred);
227		TASK_INIT(&sp->s_task, 0, nfs_freesillyrename, sp);
228		taskqueue_enqueue(taskqueue_thread, &sp->s_task);
229		mtx_lock(&np->n_mtx);
230	}
231	np->n_flag &= NMODIFIED;
232	mtx_unlock(&np->n_mtx);
233	return (0);
234}
235
236/*
237 * Reclaim an nfsnode so that it can be used for other purposes.
238 */
239int
240nfs_reclaim(struct vop_reclaim_args *ap)
241{
242	struct vnode *vp = ap->a_vp;
243	struct nfsnode *np = VTONFS(vp);
244	struct nfsdmap *dp, *dp2;
245
246	/*
247	 * If the NLM is running, give it a chance to abort pending
248	 * locks.
249	 */
250	if (nfs_reclaim_p)
251		nfs_reclaim_p(ap);
252
253	/*
254	 * Destroy the vm object and flush associated pages.
255	 */
256	vnode_destroy_vobject(vp);
257
258	vfs_hash_remove(vp);
259
260	/*
261	 * Free up any directory cookie structures and
262	 * large file handle structures that might be associated with
263	 * this nfs node.
264	 */
265	if (vp->v_type == VDIR) {
266		dp = LIST_FIRST(&np->n_cookies);
267		while (dp) {
268			dp2 = dp;
269			dp = LIST_NEXT(dp, ndm_list);
270			free((caddr_t)dp2, M_NFSDIROFF);
271		}
272	}
273	if (np->n_writecred != NULL)
274		crfree(np->n_writecred);
275	if (np->n_fhsize > NFS_SMALLFH) {
276		free((caddr_t)np->n_fhp, M_NFSBIGFH);
277	}
278	mtx_destroy(&np->n_mtx);
279	uma_zfree(nfsnode_zone, vp->v_data);
280	vp->v_data = NULL;
281	return (0);
282}
283