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. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by the University of
19 * California, Berkeley and its contributors.
20 * 4. Neither the name of the University nor the names of its contributors
21 * may be used to endorse or promote products derived from this software
22 * without specific prior written permission.
24 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36 * @(#)nfs_node.c 8.6 (Berkeley) 5/22/95
37 * $FreeBSD: src/sys/nfs/nfs_node.c,v 1.36.2.3 2002/01/05 22:25:04 dillon Exp $
41 #include <sys/param.h>
42 #include <sys/systm.h>
44 #include <sys/mount.h>
45 #include <sys/namei.h>
46 #include <sys/vnode.h>
47 #include <sys/malloc.h>
48 #include <sys/kernel.h>
49 #include <sys/fnv_hash.h>
50 #include <sys/objcache.h>
58 static MALLOC_DEFINE(M_NFSNODE, "NFS node", "NFS node");
60 static struct objcache *nfsnode_objcache;
61 static LIST_HEAD(nfsnodehashhead, nfsnode) *nfsnodehashtbl;
62 static u_long nfsnodehash;
63 static lwkt_token nfsnhash_token = LWKT_TOKEN_INITIALIZER(nfsnhash_token);
64 static struct lock nfsnhash_lock;
69 #define NFSNOHASH(fhsum) (&nfsnodehashtbl[(fhsum) & nfsnodehash])
72 * Initialize hash links for nfsnodes
73 * and build nfsnode free list.
78 nfsnode_objcache = objcache_create_simple(M_NFSNODE, sizeof(struct nfsnode));
79 nfsnodehashtbl = hashinit(desiredvnodes, M_NFSHASH, &nfsnodehash);
80 lockinit(&nfsnhash_lock, "nfsnht", 0, 0);
84 * Look up a vnode/nfsnode by file handle.
85 * Callers must check for mount points!!
86 * In all cases, a pointer to a
87 * nfsnode structure is returned.
91 nfs_nget(struct mount *mntp, nfsfh_t *fhp, int fhsize, struct nfsnode **npp)
93 struct nfsnode *np, *np2;
94 struct nfsnodehashhead *nhpp;
101 * Calculate nfs mount point and figure out whether the rslock should
102 * be interruptable or not.
104 nmp = VFSTONFS(mntp);
105 if (nmp->nm_flag & NFSMNT_INT)
110 lwkt_gettoken(&nfsnhash_token);
113 nhpp = NFSNOHASH(fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT));
115 for (np = nhpp->lh_first; np; np = np->n_hash.le_next) {
116 if (mntp != NFSTOV(np)->v_mount || np->n_fhsize != fhsize ||
117 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize)) {
121 if (vget(vp, LK_EXCLUSIVE))
123 for (np = nhpp->lh_first; np; np = np->n_hash.le_next) {
124 if (mntp == NFSTOV(np)->v_mount &&
125 np->n_fhsize == fhsize &&
126 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize) == 0
131 if (np == NULL || NFSTOV(np) != vp) {
136 lwkt_reltoken(&nfsnhash_token);
141 * Obtain a lock to prevent a race condition if the getnewvnode()
142 * or MALLOC() below happens to block.
144 if (lockmgr(&nfsnhash_lock, LK_EXCLUSIVE | LK_SLEEPFAIL))
148 * Allocate before getnewvnode since doing so afterward
149 * might cause a bogus v_data pointer to get dereferenced
150 * elsewhere if objcache should block.
152 np = objcache_get(nfsnode_objcache, M_WAITOK);
154 error = getnewvnode(VT_NFS, mntp, &vp, 0, 0);
156 lockmgr(&nfsnhash_lock, LK_RELEASE);
158 objcache_put(nfsnode_objcache, np);
159 lwkt_reltoken(&nfsnhash_token);
164 * Initialize most of (np).
166 bzero(np, sizeof (*np));
167 if (fhsize > NFS_SMALLFH) {
168 np->n_fhp = kmalloc(fhsize, M_NFSBIGFH, M_WAITOK);
170 np->n_fhp = &np->n_fh;
172 bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
173 np->n_fhsize = fhsize;
174 lockinit(&np->n_rslock, "nfrslk", 0, lkflags);
177 * Validate that we did not race another nfs_nget() due to blocking
180 for (np2 = nhpp->lh_first; np2 != NULL; np2 = np2->n_hash.le_next) {
181 if (mntp != NFSTOV(np2)->v_mount || np2->n_fhsize != fhsize ||
182 bcmp((caddr_t)fhp, (caddr_t)np2->n_fhp, fhsize)) {
186 lockmgr(&nfsnhash_lock, LK_RELEASE);
188 if (np->n_fhsize > NFS_SMALLFH)
189 kfree((caddr_t)np->n_fhp, M_NFSBIGFH);
191 objcache_put(nfsnode_objcache, np);
196 * Finish connecting up (np, vp) and insert the nfsnode in the
197 * hash for its new file handle.
199 * nvp is locked & refd so effectively so is np.
203 LIST_INSERT_HEAD(nhpp, np, n_hash);
205 lockmgr(&nfsnhash_lock, LK_RELEASE);
206 lwkt_reltoken(&nfsnhash_token);
212 * Nonblocking version of nfs_nget()
215 nfs_nget_nonblock(struct mount *mntp, nfsfh_t *fhp, int fhsize,
216 struct nfsnode **npp)
218 struct nfsnode *np, *np2;
219 struct nfsnodehashhead *nhpp;
223 struct nfsmount *nmp;
226 * Calculate nfs mount point and figure out whether the rslock should
227 * be interruptable or not.
229 nmp = VFSTONFS(mntp);
230 if (nmp->nm_flag & NFSMNT_INT)
237 lwkt_gettoken(&nfsnhash_token);
240 nhpp = NFSNOHASH(fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT));
242 for (np = nhpp->lh_first; np; np = np->n_hash.le_next) {
243 if (mntp != NFSTOV(np)->v_mount || np->n_fhsize != fhsize ||
244 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize)) {
249 if (vget(vp, LK_EXCLUSIVE | LK_NOWAIT)) {
255 if (NFSTOV(np) != vp) {
260 lwkt_reltoken(&nfsnhash_token);
265 * Not found. If we raced and had acquired a vp we have to release
274 * Obtain a lock to prevent a race condition if the getnewvnode()
275 * or MALLOC() below happens to block.
277 if (lockmgr(&nfsnhash_lock, LK_EXCLUSIVE | LK_SLEEPFAIL))
281 * Entry not found, allocate a new entry.
283 * Allocate before getnewvnode since doing so afterward
284 * might cause a bogus v_data pointer to get dereferenced
285 * elsewhere if objcache should block.
287 np = objcache_get(nfsnode_objcache, M_WAITOK);
289 error = getnewvnode(VT_NFS, mntp, &vp, 0, 0);
291 lockmgr(&nfsnhash_lock, LK_RELEASE);
292 objcache_put(nfsnode_objcache, np);
293 lwkt_reltoken(&nfsnhash_token);
298 * Initialize most of (np).
300 bzero(np, sizeof (*np));
301 if (fhsize > NFS_SMALLFH) {
302 np->n_fhp = kmalloc(fhsize, M_NFSBIGFH, M_WAITOK);
304 np->n_fhp = &np->n_fh;
306 bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
307 np->n_fhsize = fhsize;
308 lockinit(&np->n_rslock, "nfrslk", 0, lkflags);
311 * Validate that we did not race another nfs_nget() due to blocking
314 for (np2 = nhpp->lh_first; np2 != NULL; np2 = np2->n_hash.le_next) {
315 if (mntp != NFSTOV(np2)->v_mount || np2->n_fhsize != fhsize ||
316 bcmp((caddr_t)fhp, (caddr_t)np2->n_fhp, fhsize)) {
320 lockmgr(&nfsnhash_lock, LK_RELEASE);
322 if (np->n_fhsize > NFS_SMALLFH)
323 kfree((caddr_t)np->n_fhp, M_NFSBIGFH);
325 objcache_put(nfsnode_objcache, np);
328 * vp state is retained on retry/loop so we must NULL it
329 * out here or fireworks may ensue.
336 * Finish connecting up (np, vp) and insert the nfsnode in the
337 * hash for its new file handle.
339 * nvp is locked & refd so effectively so is np.
343 LIST_INSERT_HEAD(nhpp, np, n_hash);
346 * nvp is locked & refd so effectively so is np.
350 lockmgr(&nfsnhash_lock, LK_RELEASE);
352 lwkt_reltoken(&nfsnhash_token);
357 * nfs_inactive(struct vnode *a_vp)
359 * NOTE: the passed vnode is locked but not referenced. On return the
360 * vnode must be unlocked and not referenced.
363 nfs_inactive(struct vop_inactive_args *ap)
365 struct nfsmount *nmp = VFSTONFS(ap->a_vp->v_mount);
367 struct sillyrename *sp;
369 lwkt_gettoken(&nmp->nm_token);
371 np = VTONFS(ap->a_vp);
372 if (prtactive && ap->a_vp->v_sysref.refcnt > 1)
373 vprint("nfs_inactive: pushing active", ap->a_vp);
374 if (ap->a_vp->v_type != VDIR) {
375 sp = np->n_sillyrename;
376 np->n_sillyrename = NULL;
382 * We need a reference to keep the vnode from being
383 * recycled by getnewvnode while we do the I/O
384 * associated with discarding the buffers. The vnode
387 nfs_vinvalbuf(ap->a_vp, 0, 1);
390 * Remove the silly file that was rename'd earlier
395 kfree((caddr_t)sp, M_NFSREQ);
398 np->n_flag &= ~(NWRITEERR | NACC | NUPD | NCHG | NLOCKED | NWANTED);
399 lwkt_reltoken(&nmp->nm_token);
405 * Reclaim an nfsnode so that it can be used for other purposes.
407 * There should be no direct references to the related nfs node
408 * since nobody is holding the vnode any more, other than hash
409 * lookups which are interlocked against nfsnhash_token and vget().
411 * nfs_reclaim(struct vnode *a_vp)
414 nfs_reclaim(struct vop_reclaim_args *ap)
416 struct vnode *vp = ap->a_vp;
417 struct nfsnode *np = VTONFS(vp);
418 struct nfsdmap *dp, *dp2;
419 /* struct nfsmount *nmp = VFSTONFS(vp->v_mount);*/
421 if (prtactive && vp->v_sysref.refcnt > 1)
422 vprint("nfs_reclaim: pushing active", vp);
426 * Remove from hash table and remove the cross links.
428 * NOTE: Other NFS code may look up a np and vget() the
429 * related vnode, then will check np->n_vnode.
430 * We must clear np->n_vnode here to ensure that all
431 * possible races are dealt with.
433 lwkt_gettoken(&nfsnhash_token);
434 KKASSERT(np->n_vnode == vp);
435 if (np->n_hash.le_prev != NULL)
436 LIST_REMOVE(np, n_hash);
439 lwkt_reltoken(&nfsnhash_token);
442 * Free up any directory cookie structures and
443 * large file handle structures that might be associated with
446 if (vp->v_type == VDIR) {
447 dp = np->n_cookies.lh_first;
450 dp = dp->ndm_list.le_next;
451 kfree((caddr_t)dp2, M_NFSDIROFF);
454 if (np->n_fhsize > NFS_SMALLFH) {
455 kfree((caddr_t)np->n_fhp, M_NFSBIGFH);
458 crfree(np->n_rucred);
462 crfree(np->n_wucred);
465 objcache_put(nfsnode_objcache, np);