2 * Copyright (c) 1989, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
6 * Rick Macklem at The University of Guelph.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 * 3. 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.
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
32 * @(#)nfs_node.c 8.6 (Berkeley) 5/22/95
33 * $FreeBSD: src/sys/nfs/nfs_node.c,v 1.36.2.3 2002/01/05 22:25:04 dillon Exp $
37 #include <sys/param.h>
38 #include <sys/systm.h>
40 #include <sys/mount.h>
41 #include <sys/vnode.h>
42 #include <sys/malloc.h>
43 #include <sys/kernel.h>
44 #include <sys/fnv_hash.h>
45 #include <sys/objcache.h>
53 static MALLOC_DEFINE(M_NFSNODE, "NFS node", "NFS node");
55 static struct lwkt_token nfsnhash_token =
56 LWKT_TOKEN_INITIALIZER(nfsnhash_token);
57 static struct lock nfsnhash_lock;
58 __read_mostly static struct objcache *nfsnode_objcache;
59 __read_mostly static LIST_HEAD(nfsnodehashhead, nfsnode) *nfsnodehashtbl;
60 __read_mostly static u_long nfsnodehash;
65 #define NFSNOHASH(fhsum) (&nfsnodehashtbl[(fhsum) & nfsnodehash])
68 * Initialize hash links for nfsnodes
69 * and build nfsnode free list.
74 int hsize = vfs_inodehashsize();
76 nfsnode_objcache = objcache_create_simple(M_NFSNODE,
77 sizeof(struct nfsnode));
78 nfsnodehashtbl = hashinit(hsize, M_NFSHASH, &nfsnodehash);
79 lockinit(&nfsnhash_lock, "nfsnht", 0, 0);
85 hashdestroy(nfsnodehashtbl, M_NFSHASH, nfsnodehash);
86 objcache_destroy(nfsnode_objcache);
90 * Look up a vnode/nfsnode by file handle.
91 * Callers must check for mount points!!
92 * In all cases, a pointer to a
93 * nfsnode structure is returned.
97 nfs_nget(struct mount *mntp, nfsfh_t *fhp, int fhsize, struct nfsnode **npp,
100 struct nfsnode *np, *np2;
101 struct nfsnodehashhead *nhpp;
105 struct nfsmount *nmp;
108 * Calculate nfs mount point and figure out whether the rslock should
109 * be interruptable or not.
111 nmp = VFSTONFS(mntp);
112 if (nmp->nm_flag & NFSMNT_INT)
117 lwkt_gettoken(&nfsnhash_token);
120 nhpp = NFSNOHASH(fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT));
122 LIST_FOREACH(np, nhpp, n_hash) {
123 if (mntp != NFSTOV(np)->v_mount || np->n_fhsize != fhsize ||
124 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize)) {
129 kprintf("nfs warning: client-client collision "
130 "during rename/link/softlink\n");
132 lwkt_reltoken(&nfsnhash_token);
135 if (vget(vp, LK_EXCLUSIVE))
137 LIST_FOREACH(np, nhpp, n_hash) {
138 if (mntp == NFSTOV(np)->v_mount &&
139 np->n_fhsize == fhsize &&
140 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize) == 0
145 if (np == NULL || NFSTOV(np) != vp) {
150 lwkt_reltoken(&nfsnhash_token);
155 * Obtain a lock to prevent a race condition if the getnewvnode()
156 * or MALLOC() below happens to block.
158 if (lockmgr(&nfsnhash_lock, LK_EXCLUSIVE | LK_SLEEPFAIL))
162 * Allocate before getnewvnode since doing so afterward
163 * might cause a bogus v_data pointer to get dereferenced
164 * elsewhere if objcache should block.
166 np = objcache_get(nfsnode_objcache, M_WAITOK);
168 error = getnewvnode(VT_NFS, mntp, &vp, 0, 0);
170 lockmgr(&nfsnhash_lock, LK_RELEASE);
172 objcache_put(nfsnode_objcache, np);
173 lwkt_reltoken(&nfsnhash_token);
178 * Initialize most of (np).
180 bzero(np, sizeof (*np));
181 if (fhsize > NFS_SMALLFH) {
182 np->n_fhp = kmalloc(fhsize, M_NFSBIGFH, M_WAITOK);
184 np->n_fhp = &np->n_fh;
186 bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
187 np->n_fhsize = fhsize;
188 lockinit(&np->n_rslock, "nfrslk", 0, lkflags);
191 * Validate that we did not race another nfs_nget() due to blocking
194 for (np2 = nhpp->lh_first; np2 != NULL; np2 = np2->n_hash.le_next) {
195 if (mntp != NFSTOV(np2)->v_mount || np2->n_fhsize != fhsize ||
196 bcmp((caddr_t)fhp, (caddr_t)np2->n_fhp, fhsize)) {
200 lockmgr(&nfsnhash_lock, LK_RELEASE);
202 if (np->n_fhsize > NFS_SMALLFH)
203 kfree((caddr_t)np->n_fhp, M_NFSBIGFH);
205 objcache_put(nfsnode_objcache, np);
210 * Finish connecting up (np, vp) and insert the nfsnode in the
211 * hash for its new file handle.
213 * nvp is locked & refd so effectively so is np.
217 LIST_INSERT_HEAD(nhpp, np, n_hash);
219 lockmgr(&nfsnhash_lock, LK_RELEASE);
220 lwkt_reltoken(&nfsnhash_token);
227 * Nonblocking version of nfs_nget()
230 nfs_nget_nonblock(struct mount *mntp, nfsfh_t *fhp, int fhsize,
231 struct nfsnode **npp, struct vnode *notvp)
233 struct nfsnode *np, *np2;
234 struct nfsnodehashhead *nhpp;
238 struct nfsmount *nmp;
241 * Calculate nfs mount point and figure out whether the rslock should
242 * be interruptable or not.
244 nmp = VFSTONFS(mntp);
245 if (nmp->nm_flag & NFSMNT_INT)
252 lwkt_gettoken(&nfsnhash_token);
255 nhpp = NFSNOHASH(fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT));
257 LIST_FOREACH(np, nhpp, n_hash) {
258 if (mntp != NFSTOV(np)->v_mount || np->n_fhsize != fhsize ||
259 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize)) {
265 kprintf("nfs warning: client-client collision "
266 "during rename/link/softlink\n");
270 if (vget(vp, LK_EXCLUSIVE | LK_NOWAIT)) {
276 if (NFSTOV(np) != vp) {
281 lwkt_reltoken(&nfsnhash_token);
286 * Not found. If we raced and had acquired a vp we have to release
295 * Obtain a lock to prevent a race condition if the getnewvnode()
296 * or MALLOC() below happens to block.
298 if (lockmgr(&nfsnhash_lock, LK_EXCLUSIVE | LK_SLEEPFAIL))
302 * Entry not found, allocate a new entry.
304 * Allocate before getnewvnode since doing so afterward
305 * might cause a bogus v_data pointer to get dereferenced
306 * elsewhere if objcache should block.
308 np = objcache_get(nfsnode_objcache, M_WAITOK);
310 error = getnewvnode(VT_NFS, mntp, &vp, 0, 0);
312 lockmgr(&nfsnhash_lock, LK_RELEASE);
313 objcache_put(nfsnode_objcache, np);
314 lwkt_reltoken(&nfsnhash_token);
319 * Initialize most of (np).
321 bzero(np, sizeof (*np));
322 if (fhsize > NFS_SMALLFH) {
323 np->n_fhp = kmalloc(fhsize, M_NFSBIGFH, M_WAITOK);
325 np->n_fhp = &np->n_fh;
327 bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
328 np->n_fhsize = fhsize;
329 lockinit(&np->n_rslock, "nfrslk", 0, lkflags);
332 * Validate that we did not race another nfs_nget() due to blocking
335 for (np2 = nhpp->lh_first; np2 != NULL; np2 = np2->n_hash.le_next) {
336 if (mntp != NFSTOV(np2)->v_mount || np2->n_fhsize != fhsize ||
337 bcmp((caddr_t)fhp, (caddr_t)np2->n_fhp, fhsize)) {
341 lockmgr(&nfsnhash_lock, LK_RELEASE);
343 if (np->n_fhsize > NFS_SMALLFH)
344 kfree((caddr_t)np->n_fhp, M_NFSBIGFH);
346 objcache_put(nfsnode_objcache, np);
349 * vp state is retained on retry/loop so we must NULL it
350 * out here or fireworks may ensue.
357 * Finish connecting up (np, vp) and insert the nfsnode in the
358 * hash for its new file handle.
360 * nvp is locked & refd so effectively so is np.
364 LIST_INSERT_HEAD(nhpp, np, n_hash);
367 * nvp is locked & refd so effectively so is np.
371 lockmgr(&nfsnhash_lock, LK_RELEASE);
374 lwkt_reltoken(&nfsnhash_token);
379 * nfs_inactive(struct vnode *a_vp)
381 * NOTE: the passed vnode is locked but not referenced. On return the
382 * vnode must be unlocked and not referenced.
385 nfs_inactive(struct vop_inactive_args *ap)
387 struct nfsmount *nmp = VFSTONFS(ap->a_vp->v_mount);
389 struct sillyrename *sp;
391 lwkt_gettoken(&nmp->nm_token);
393 np = VTONFS(ap->a_vp);
394 if (prtactive && VREFCNT(ap->a_vp) > 1)
395 vprint("nfs_inactive: pushing active", ap->a_vp);
396 if (ap->a_vp->v_type != VDIR) {
397 sp = np->n_sillyrename;
398 np->n_sillyrename = NULL;
404 * We need a reference to keep the vnode from being
405 * recycled by getnewvnode while we do the I/O
406 * associated with discarding the buffers. The vnode
409 nfs_vinvalbuf(ap->a_vp, 0, 1);
412 * Remove the silly file that was rename'd earlier
417 kfree((caddr_t)sp, M_NFSREQ);
420 np->n_flag &= ~(NWRITEERR | NACC | NUPD | NCHG | NLOCKED | NWANTED);
421 if (np->n_flag & NREMOVED)
423 lwkt_reltoken(&nmp->nm_token);
429 * Reclaim an nfsnode so that it can be used for other purposes.
431 * There should be no direct references to the related nfs node
432 * since nobody is holding the vnode any more, other than hash
433 * lookups which are interlocked against nfsnhash_token and vget().
435 * nfs_reclaim(struct vnode *a_vp)
438 nfs_reclaim(struct vop_reclaim_args *ap)
440 struct vnode *vp = ap->a_vp;
441 struct nfsnode *np = VTONFS(vp);
442 struct nfsdmap *dp, *dp2;
443 /* struct nfsmount *nmp = VFSTONFS(vp->v_mount);*/
445 if (prtactive && VREFCNT(vp) > 1)
446 vprint("nfs_reclaim: pushing active", vp);
450 * Remove from hash table and remove the cross links.
452 * NOTE: Other NFS code may look up a np and vget() the
453 * related vnode, then will check np->n_vnode.
454 * We must clear np->n_vnode here to ensure that all
455 * possible races are dealt with.
457 lwkt_gettoken(&nfsnhash_token);
458 KKASSERT(np->n_vnode == vp);
459 if (np->n_hash.le_prev != NULL)
460 LIST_REMOVE(np, n_hash);
463 lwkt_reltoken(&nfsnhash_token);
466 * Free up any directory cookie structures and
467 * large file handle structures that might be associated with
470 if (vp->v_type == VDIR) {
471 dp = np->n_cookies.lh_first;
474 dp = dp->ndm_list.le_next;
475 kfree((caddr_t)dp2, M_NFSDIROFF);
478 if (np->n_fhsize > NFS_SMALLFH) {
479 kfree((caddr_t)np->n_fhp, M_NFSBIGFH);
482 crfree(np->n_rucred);
486 crfree(np->n_wucred);
489 objcache_put(nfsnode_objcache, np);