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 $
38 * $DragonFly: src/sys/vfs/nfs/nfs_node.c,v 1.27 2007/08/08 00:12:51 swildner Exp $
42 #include <sys/param.h>
43 #include <sys/systm.h>
45 #include <sys/mount.h>
46 #include <sys/namei.h>
47 #include <sys/vnode.h>
48 #include <sys/malloc.h>
49 #include <sys/kernel.h>
50 #include <sys/fnv_hash.h>
51 #include <sys/objcache.h>
59 static MALLOC_DEFINE(M_NFSNODE, "NFS node", "NFS node");
61 static struct objcache *nfsnode_objcache;
62 static LIST_HEAD(nfsnodehashhead, nfsnode) *nfsnodehashtbl;
63 static u_long nfsnodehash;
64 static lwkt_token nfsnhash_token = LWKT_TOKEN_INITIALIZER(nfsnhash_token);
65 static struct lock nfsnhash_lock;
70 #define NFSNOHASH(fhsum) (&nfsnodehashtbl[(fhsum) & nfsnodehash])
73 * Initialize hash links for nfsnodes
74 * and build nfsnode free list.
79 nfsnode_objcache = objcache_create_simple(M_NFSNODE, sizeof(struct nfsnode));
80 nfsnodehashtbl = hashinit(desiredvnodes, M_NFSHASH, &nfsnodehash);
81 lockinit(&nfsnhash_lock, "nfsnht", 0, 0);
85 * Look up a vnode/nfsnode by file handle.
86 * Callers must check for mount points!!
87 * In all cases, a pointer to a
88 * nfsnode structure is returned.
92 nfs_nget(struct mount *mntp, nfsfh_t *fhp, int fhsize, struct nfsnode **npp)
94 struct nfsnode *np, *np2;
95 struct nfsnodehashhead *nhpp;
102 * Calculate nfs mount point and figure out whether the rslock should
103 * be interruptable or not.
105 nmp = VFSTONFS(mntp);
106 if (nmp->nm_flag & NFSMNT_INT)
111 lwkt_gettoken(&nfsnhash_token);
114 nhpp = NFSNOHASH(fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT));
116 for (np = nhpp->lh_first; np; np = np->n_hash.le_next) {
117 if (mntp != NFSTOV(np)->v_mount || np->n_fhsize != fhsize ||
118 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize)) {
122 if (vget(vp, LK_EXCLUSIVE))
124 for (np = nhpp->lh_first; np; np = np->n_hash.le_next) {
125 if (mntp == NFSTOV(np)->v_mount &&
126 np->n_fhsize == fhsize &&
127 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize) == 0
132 if (np == NULL || NFSTOV(np) != vp) {
137 lwkt_reltoken(&nfsnhash_token);
142 * Obtain a lock to prevent a race condition if the getnewvnode()
143 * or MALLOC() below happens to block.
145 if (lockmgr(&nfsnhash_lock, LK_EXCLUSIVE | LK_SLEEPFAIL))
149 * Allocate before getnewvnode since doing so afterward
150 * might cause a bogus v_data pointer to get dereferenced
151 * elsewhere if objcache should block.
153 np = objcache_get(nfsnode_objcache, M_WAITOK);
155 error = getnewvnode(VT_NFS, mntp, &vp, 0, 0);
157 lockmgr(&nfsnhash_lock, LK_RELEASE);
159 objcache_put(nfsnode_objcache, np);
160 lwkt_reltoken(&nfsnhash_token);
165 * Initialize most of (np).
167 bzero(np, sizeof (*np));
168 if (fhsize > NFS_SMALLFH) {
169 MALLOC(np->n_fhp, nfsfh_t *, fhsize, M_NFSBIGFH, M_WAITOK);
171 np->n_fhp = &np->n_fh;
173 bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
174 np->n_fhsize = fhsize;
175 lockinit(&np->n_rslock, "nfrslk", 0, lkflags);
178 * Validate that we did not race another nfs_nget() due to blocking
181 for (np2 = nhpp->lh_first; np2 != 0; np2 = np2->n_hash.le_next) {
182 if (mntp != NFSTOV(np2)->v_mount || np2->n_fhsize != fhsize ||
183 bcmp((caddr_t)fhp, (caddr_t)np2->n_fhp, fhsize)) {
187 lockmgr(&nfsnhash_lock, LK_RELEASE);
189 if (np->n_fhsize > NFS_SMALLFH)
190 FREE((caddr_t)np->n_fhp, M_NFSBIGFH);
192 objcache_put(nfsnode_objcache, np);
197 * Finish connecting up (np, vp) and insert the nfsnode in the
198 * hash for its new file handle.
200 * nvp is locked & refd so effectively so is np.
204 LIST_INSERT_HEAD(nhpp, np, n_hash);
206 lockmgr(&nfsnhash_lock, LK_RELEASE);
207 lwkt_reltoken(&nfsnhash_token);
213 * Nonblocking version of nfs_nget()
216 nfs_nget_nonblock(struct mount *mntp, nfsfh_t *fhp, int fhsize,
217 struct nfsnode **npp)
219 struct nfsnode *np, *np2;
220 struct nfsnodehashhead *nhpp;
224 struct nfsmount *nmp;
227 * Calculate nfs mount point and figure out whether the rslock should
228 * be interruptable or not.
230 nmp = VFSTONFS(mntp);
231 if (nmp->nm_flag & NFSMNT_INT)
238 lwkt_gettoken(&nfsnhash_token);
241 nhpp = NFSNOHASH(fnv_32_buf(fhp->fh_bytes, fhsize, FNV1_32_INIT));
243 for (np = nhpp->lh_first; np; np = np->n_hash.le_next) {
244 if (mntp != NFSTOV(np)->v_mount || np->n_fhsize != fhsize ||
245 bcmp((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize)) {
250 if (vget(vp, LK_EXCLUSIVE | LK_NOWAIT)) {
256 if (NFSTOV(np) != vp) {
261 lwkt_reltoken(&nfsnhash_token);
266 * Not found. If we raced and had acquired a vp we have to release
275 * Obtain a lock to prevent a race condition if the getnewvnode()
276 * or MALLOC() below happens to block.
278 if (lockmgr(&nfsnhash_lock, LK_EXCLUSIVE | LK_SLEEPFAIL))
282 * Entry not found, allocate a new entry.
284 * Allocate before getnewvnode since doing so afterward
285 * might cause a bogus v_data pointer to get dereferenced
286 * elsewhere if objcache should block.
288 np = objcache_get(nfsnode_objcache, M_WAITOK);
290 error = getnewvnode(VT_NFS, mntp, &vp, 0, 0);
292 lockmgr(&nfsnhash_lock, LK_RELEASE);
293 objcache_put(nfsnode_objcache, np);
294 lwkt_reltoken(&nfsnhash_token);
299 * Initialize most of (np).
301 bzero(np, sizeof (*np));
302 if (fhsize > NFS_SMALLFH) {
303 MALLOC(np->n_fhp, nfsfh_t *, fhsize, M_NFSBIGFH, M_WAITOK);
305 np->n_fhp = &np->n_fh;
307 bcopy((caddr_t)fhp, (caddr_t)np->n_fhp, fhsize);
308 np->n_fhsize = fhsize;
309 lockinit(&np->n_rslock, "nfrslk", 0, lkflags);
312 * Validate that we did not race another nfs_nget() due to blocking
315 for (np2 = nhpp->lh_first; np2 != 0; np2 = np2->n_hash.le_next) {
316 if (mntp != NFSTOV(np2)->v_mount || np2->n_fhsize != fhsize ||
317 bcmp((caddr_t)fhp, (caddr_t)np2->n_fhp, fhsize)) {
321 lockmgr(&nfsnhash_lock, LK_RELEASE);
323 if (np->n_fhsize > NFS_SMALLFH)
324 FREE((caddr_t)np->n_fhp, M_NFSBIGFH);
326 objcache_put(nfsnode_objcache, np);
329 * vp state is retained on retry/loop so we must NULL it
330 * out here or fireworks may ensue.
337 * Finish connecting up (np, vp) and insert the nfsnode in the
338 * hash for its new file handle.
340 * nvp is locked & refd so effectively so is np.
344 LIST_INSERT_HEAD(nhpp, np, n_hash);
347 * nvp is locked & refd so effectively so is np.
351 lockmgr(&nfsnhash_lock, LK_RELEASE);
353 lwkt_reltoken(&nfsnhash_token);
358 * nfs_inactive(struct vnode *a_vp)
360 * NOTE: the passed vnode is locked but not referenced. On return the
361 * vnode must be unlocked and not referenced.
364 nfs_inactive(struct vop_inactive_args *ap)
366 struct nfsmount *nmp = VFSTONFS(ap->a_vp->v_mount);
368 struct sillyrename *sp;
370 lwkt_gettoken(&nmp->nm_token);
372 np = VTONFS(ap->a_vp);
373 if (prtactive && ap->a_vp->v_sysref.refcnt > 1)
374 vprint("nfs_inactive: pushing active", ap->a_vp);
375 if (ap->a_vp->v_type != VDIR) {
376 sp = np->n_sillyrename;
377 np->n_sillyrename = NULL;
383 * We need a reference to keep the vnode from being
384 * recycled by getnewvnode while we do the I/O
385 * associated with discarding the buffers. The vnode
388 nfs_vinvalbuf(ap->a_vp, 0, 1);
391 * Remove the silly file that was rename'd earlier
396 FREE((caddr_t)sp, M_NFSREQ);
399 np->n_flag &= ~(NWRITEERR | NACC | NUPD | NCHG | NLOCKED | NWANTED);
400 lwkt_reltoken(&nmp->nm_token);
406 * Reclaim an nfsnode so that it can be used for other purposes.
408 * There should be no direct references to the related nfs node
409 * since nobody is holding the vnode any more, other than hash
410 * lookups which are interlocked against nfsnhash_token and vget().
412 * nfs_reclaim(struct vnode *a_vp)
415 nfs_reclaim(struct vop_reclaim_args *ap)
417 struct vnode *vp = ap->a_vp;
418 struct nfsnode *np = VTONFS(vp);
419 struct nfsdmap *dp, *dp2;
420 /* struct nfsmount *nmp = VFSTONFS(vp->v_mount);*/
422 if (prtactive && vp->v_sysref.refcnt > 1)
423 vprint("nfs_reclaim: pushing active", vp);
427 * Remove from hash table and remove the cross links.
429 * NOTE: Other NFS code may look up a np and vget() the
430 * related vnode, then will check np->n_vnode.
431 * We must clear np->n_vnode here to ensure that all
432 * possible races are dealt with.
434 lwkt_gettoken(&nfsnhash_token);
435 KKASSERT(np->n_vnode == vp);
436 if (np->n_hash.le_prev != NULL)
437 LIST_REMOVE(np, n_hash);
440 lwkt_reltoken(&nfsnhash_token);
443 * Free up any directory cookie structures and
444 * large file handle structures that might be associated with
447 if (vp->v_type == VDIR) {
448 dp = np->n_cookies.lh_first;
451 dp = dp->ndm_list.le_next;
452 FREE((caddr_t)dp2, M_NFSDIROFF);
455 if (np->n_fhsize > NFS_SMALLFH) {
456 FREE((caddr_t)np->n_fhp, M_NFSBIGFH);
459 crfree(np->n_rucred);
463 crfree(np->n_wucred);
466 objcache_put(nfsnode_objcache, np);