NetBSD/sys/kern/vfs_cache.c

500 lines
13 KiB
C
Raw Normal View History

/* $NetBSD: vfs_cache.c,v 1.29 2001/03/29 22:39:23 fvdl Exp $ */
1993-03-21 12:45:37 +03:00
/*
1994-06-08 15:28:29 +04:00
* Copyright (c) 1989, 1993
* The Regents of the University of California. All rights reserved.
1993-03-21 12:45:37 +03:00
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the University of
* California, Berkeley and its contributors.
* 4. Neither the name of the University nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
1994-12-13 12:14:34 +03:00
* @(#)vfs_cache.c 8.3 (Berkeley) 8/22/94
1993-03-21 12:45:37 +03:00
*/
#include "opt_ddb.h"
#include "opt_revcache.h"
1993-12-18 07:21:37 +03:00
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/time.h>
#include <sys/mount.h>
#include <sys/vnode.h>
#include <sys/namei.h>
#include <sys/errno.h>
#include <sys/malloc.h>
#include <sys/pool.h>
1993-03-21 12:45:37 +03:00
/*
* Name caching works as follows:
*
* Names found by directory scans are retained in a cache
* for future reference. It is managed LRU, so frequently
* used names will hang around. Cache is indexed by hash value
* obtained from (dvp, name) where dvp refers to the directory
1993-03-21 12:45:37 +03:00
* containing name.
*
* For simplicity (and economy of storage), names longer than
* a maximum length of NCHNAMLEN are not cached; they occur
* infrequently in any case, and are almost never of interest.
*
* Upon reaching the last segment of a path, if the reference
* is for DELETE, or NOCACHE is set (rewrite), and the
* name is located in the cache, it will be dropped.
* The entry is dropped also when it was not possible to lock
* the cached vnode, either because vget() failed or the generation
* number has changed while waiting for the lock.
1993-03-21 12:45:37 +03:00
*/
/*
* Structures associated with name cacheing.
*/
LIST_HEAD(nchashhead, namecache) *nchashtbl;
1993-03-21 12:45:37 +03:00
u_long nchash; /* size of hash table - 1 */
long numcache; /* number of cache entries allocated */
LIST_HEAD(ncvhashhead, namecache) *ncvhashtbl;
u_long ncvhash; /* size of hash table - 1 */
TAILQ_HEAD(, namecache) nclruhead; /* LRU chain */
1993-03-21 12:45:37 +03:00
struct nchstats nchstats; /* cache effectiveness statistics */
struct pool namecache_pool;
1994-07-03 00:26:19 +04:00
int doingcache = 1; /* 1 => enable the cache */
1993-03-21 12:45:37 +03:00
/*
* Look for a the name in the cache. We don't do this
* if the segment name is long, simply so the cache can avoid
* holding long names (which would either waste space, or
* add greatly to the complexity).
*
* Lookup is called with ni_dvp pointing to the directory to search,
* ni_ptr pointing to the name of the entry being sought, ni_namelen
* tells the length of the name, and ni_hash contains a hash of
* the name. If the lookup succeeds, the vnode is locked, stored in ni_vp
* and a status of zero is returned. If the locking fails for whatever
* reason, the vnode is unlocked and the error is returned to caller.
* If the lookup determines that the name does not exist (negative cacheing),
* a status of ENOENT is returned. If the lookup fails, a status of -1
* is returned.
1993-03-21 12:45:37 +03:00
*/
1994-06-08 15:28:29 +04:00
int
cache_lookup(dvp, vpp, cnp)
struct vnode *dvp;
struct vnode **vpp;
struct componentname *cnp;
1993-03-21 12:45:37 +03:00
{
2000-03-30 13:27:11 +04:00
struct namecache *ncp;
struct nchashhead *ncpp;
struct vnode *vp;
int vpid, error;
1993-03-21 12:45:37 +03:00
if (!doingcache) {
cnp->cn_flags &= ~MAKEENTRY;
*vpp = 0;
return (-1);
}
1994-06-08 15:28:29 +04:00
if (cnp->cn_namelen > NCHNAMLEN) {
1993-03-21 12:45:37 +03:00
nchstats.ncs_long++;
1994-06-08 15:28:29 +04:00
cnp->cn_flags &= ~MAKEENTRY;
*vpp = 0;
return (-1);
1993-03-21 12:45:37 +03:00
}
1995-09-08 18:15:07 +04:00
ncpp = &nchashtbl[(cnp->cn_hash ^ dvp->v_id) & nchash];
LIST_FOREACH(ncp, ncpp, nc_hash) {
1993-03-21 12:45:37 +03:00
if (ncp->nc_dvp == dvp &&
ncp->nc_dvpid == dvp->v_id &&
1994-06-08 15:28:29 +04:00
ncp->nc_nlen == cnp->cn_namelen &&
!memcmp(ncp->nc_name, cnp->cn_nameptr, (u_int)ncp->nc_nlen))
1993-03-21 12:45:37 +03:00
break;
}
if (ncp == 0) {
1993-03-21 12:45:37 +03:00
nchstats.ncs_miss++;
*vpp = 0;
return (-1);
1993-03-21 12:45:37 +03:00
}
if ((cnp->cn_flags & MAKEENTRY) == 0) {
1993-03-21 12:45:37 +03:00
nchstats.ncs_badhits++;
goto remove;
1993-03-21 12:45:37 +03:00
} else if (ncp->nc_vp == NULL) {
/*
* Restore the ISWHITEOUT flag saved earlier.
*/
cnp->cn_flags |= ncp->nc_vpid;
if (cnp->cn_nameiop != CREATE ||
(cnp->cn_flags & ISLASTCN) == 0) {
1993-03-21 12:45:37 +03:00
nchstats.ncs_neghits++;
/*
* Move this slot to end of LRU chain,
* if not already there.
*/
if (ncp->nc_lru.tqe_next != 0) {
TAILQ_REMOVE(&nclruhead, ncp, nc_lru);
TAILQ_INSERT_TAIL(&nclruhead, ncp, nc_lru);
1993-03-21 12:45:37 +03:00
}
return (ENOENT);
} else {
1998-03-01 05:20:01 +03:00
nchstats.ncs_badhits++;
goto remove;
}
1993-03-21 12:45:37 +03:00
} else if (ncp->nc_vpid != ncp->nc_vp->v_id) {
nchstats.ncs_falsehits++;
goto remove;
}
vp = ncp->nc_vp;
vpid = vp->v_id;
if (vp == dvp) { /* lookup on "." */
VREF(dvp);
error = 0;
} else if (cnp->cn_flags & ISDOTDOT) {
VOP_UNLOCK(dvp, 0);
cnp->cn_flags |= PDIRUNLOCK;
error = vget(vp, LK_EXCLUSIVE);
/* if the above vget() succeeded and both LOCKPARENT and
* ISLASTCN is set, lock the directory vnode as well */
if (!error && (~cnp->cn_flags & (LOCKPARENT|ISLASTCN)) == 0) {
if ((error = vn_lock(dvp, LK_EXCLUSIVE)) != 0) {
vput(vp);
return (error);
}
cnp->cn_flags &= ~PDIRUNLOCK;
}
1993-03-21 12:45:37 +03:00
} else {
error = vget(vp, LK_EXCLUSIVE);
/* if the above vget() failed or either of LOCKPARENT or
* ISLASTCN is set, unlock the directory vnode */
if (error || (~cnp->cn_flags & (LOCKPARENT|ISLASTCN)) != 0) {
VOP_UNLOCK(dvp, 0);
cnp->cn_flags |= PDIRUNLOCK;
}
}
/*
* Check that the lock succeeded, and that the capability number did
* not change while we were waiting for the lock.
*/
if (error || vpid != vp->v_id) {
if (!error) {
vput(vp);
nchstats.ncs_falsehits++;
} else
nchstats.ncs_badhits++;
1993-03-21 12:45:37 +03:00
/*
* The parent needs to be locked when we return to VOP_LOOKUP().
* The `.' case here should be extremely rare (if it can happen
* at all), so we don't bother optimizing out the unlock/relock.
1993-03-21 12:45:37 +03:00
*/
if (vp == dvp ||
error || (~cnp->cn_flags & (LOCKPARENT|ISLASTCN)) != 0) {
if ((error = vn_lock(dvp, LK_EXCLUSIVE)) != 0)
return (error);
cnp->cn_flags &= ~PDIRUNLOCK;
1993-03-21 12:45:37 +03:00
}
goto remove;
1993-03-21 12:45:37 +03:00
}
nchstats.ncs_goodhits++;
/*
* move this slot to end of LRU chain, if not already there
*/
if (ncp->nc_lru.tqe_next != 0) {
TAILQ_REMOVE(&nclruhead, ncp, nc_lru);
TAILQ_INSERT_TAIL(&nclruhead, ncp, nc_lru);
}
*vpp = vp;
return (0);
remove:
1993-03-21 12:45:37 +03:00
/*
* Last component and we are renaming or deleting,
* the cache entry is invalid, or otherwise don't
* want cache entry to exist.
*/
TAILQ_REMOVE(&nclruhead, ncp, nc_lru);
LIST_REMOVE(ncp, nc_hash);
ncp->nc_hash.le_prev = 0;
if (ncp->nc_vhash.le_prev != NULL) {
LIST_REMOVE(ncp, nc_vhash);
ncp->nc_vhash.le_prev = 0;
}
TAILQ_INSERT_HEAD(&nclruhead, ncp, nc_lru);
*vpp = 0;
return (-1);
1993-03-21 12:45:37 +03:00
}
/*
* Scan cache looking for name of directory entry pointing at vp.
*
* Fill in dvpp.
*
* If bufp is non-NULL, also place the name in the buffer which starts
* at bufp, immediately before *bpp, and move bpp backwards to point
* at the start of it. (Yes, this is a little baroque, but it's done
* this way to cater to the whims of getcwd).
*
* Returns 0 on success, -1 on cache miss, positive errno on failure.
*/
int
cache_revlookup (vp, dvpp, bpp, bufp)
struct vnode *vp, **dvpp;
char **bpp;
char *bufp;
{
struct namecache *ncp;
struct vnode *dvp;
struct ncvhashhead *nvcpp;
if (!doingcache)
goto out;
nvcpp = &ncvhashtbl[(vp->v_id & ncvhash)];
LIST_FOREACH(ncp, nvcpp, nc_vhash) {
if ((ncp->nc_vp == vp) &&
(ncp->nc_vpid == vp->v_id) &&
((dvp = ncp->nc_dvp) != 0) &&
(dvp != vp) && /* avoid pesky . entries.. */
(dvp->v_id == ncp->nc_dvpid))
{
char *bp;
#ifdef DIAGNOSTIC
if ((ncp->nc_nlen == 1) &&
(ncp->nc_name[0] == '.'))
panic("cache_revlookup: found entry for .");
if ((ncp->nc_nlen == 2) &&
(ncp->nc_name[0] == '.') &&
(ncp->nc_name[1] == '.'))
panic("cache_revlookup: found entry for ..");
#endif
nchstats.ncs_revhits++;
if (bufp) {
bp = *bpp;
bp -= ncp->nc_nlen;
if (bp <= bufp) {
*dvpp = 0;
return ERANGE;
}
memcpy(bp, ncp->nc_name, ncp->nc_nlen);
*bpp = bp;
}
/* XXX MP: how do we know dvp won't evaporate? */
*dvpp = dvp;
return 0;
}
}
nchstats.ncs_revmiss++;
out:
*dvpp = 0;
return -1;
}
1993-03-21 12:45:37 +03:00
/*
* Add an entry to the cache
*/
1996-02-04 05:17:43 +03:00
void
1994-06-08 15:28:29 +04:00
cache_enter(dvp, vp, cnp)
struct vnode *dvp;
struct vnode *vp;
struct componentname *cnp;
1993-03-21 12:45:37 +03:00
{
2000-03-30 13:27:11 +04:00
struct namecache *ncp;
struct nchashhead *ncpp;
struct ncvhashhead *nvcpp;
1993-03-21 12:45:37 +03:00
1994-06-08 15:28:29 +04:00
#ifdef DIAGNOSTIC
if (cnp->cn_namelen > NCHNAMLEN)
panic("cache_enter: name too long");
#endif
1993-03-21 12:45:37 +03:00
if (!doingcache)
return;
/*
* Free the cache slot at head of lru chain.
*/
if (numcache < numvnodes) {
ncp = pool_get(&namecache_pool, PR_WAITOK);
memset(ncp, 0, sizeof(*ncp));
1993-03-21 12:45:37 +03:00
numcache++;
} else if ((ncp = TAILQ_FIRST(&nclruhead)) != NULL) {
TAILQ_REMOVE(&nclruhead, ncp, nc_lru);
if (ncp->nc_hash.le_prev != 0) {
LIST_REMOVE(ncp, nc_hash);
ncp->nc_hash.le_prev = 0;
1994-06-08 15:28:29 +04:00
}
if (ncp->nc_vhash.le_prev != 0) {
LIST_REMOVE(ncp, nc_vhash);
ncp->nc_vhash.le_prev = 0;
}
1993-03-21 12:45:37 +03:00
} else
return;
/* grab the vnode we just found */
1994-06-08 15:28:29 +04:00
ncp->nc_vp = vp;
if (vp)
ncp->nc_vpid = vp->v_id;
else {
/*
* For negative hits, save the ISWHITEOUT flag so we can
* restore it later when the cache entry is used again.
*/
ncp->nc_vpid = cnp->cn_flags & ISWHITEOUT;
}
1993-03-21 12:45:37 +03:00
/* fill in cache info */
1994-06-08 15:28:29 +04:00
ncp->nc_dvp = dvp;
ncp->nc_dvpid = dvp->v_id;
ncp->nc_nlen = cnp->cn_namelen;
memcpy(ncp->nc_name, cnp->cn_nameptr, (unsigned)ncp->nc_nlen);
TAILQ_INSERT_TAIL(&nclruhead, ncp, nc_lru);
1995-09-08 18:15:07 +04:00
ncpp = &nchashtbl[(cnp->cn_hash ^ dvp->v_id) & nchash];
LIST_INSERT_HEAD(ncpp, ncp, nc_hash);
ncp->nc_vhash.le_prev = 0;
ncp->nc_vhash.le_next = 0;
/*
* Create reverse-cache entries (used in getcwd) for directories.
*/
if (vp &&
(vp != dvp) &&
#ifndef NAMECACHE_ENTER_REVERSE
(vp->v_type == VDIR) &&
#endif
((ncp->nc_nlen > 2) ||
((ncp->nc_nlen == 2) && (ncp->nc_name[0] != '.') && (ncp->nc_name[1] != '.')) ||
((ncp->nc_nlen == 1) && (ncp->nc_name[0] != '.'))))
{
nvcpp = &ncvhashtbl[(vp->v_id & ncvhash)];
LIST_INSERT_HEAD(nvcpp, ncp, nc_vhash);
}
1993-03-21 12:45:37 +03:00
}
/*
* Name cache initialization, from vfs_init() when we are booting
*/
1996-02-04 05:17:43 +03:00
void
1993-03-21 12:45:37 +03:00
nchinit()
{
TAILQ_INIT(&nclruhead);
2000-11-08 17:28:12 +03:00
nchashtbl =
hashinit(desiredvnodes, HASH_LIST, M_CACHE, M_WAITOK, &nchash);
ncvhashtbl =
#ifdef NAMECACHE_ENTER_REVERSE
hashinit(desiredvnodes, HASH_LIST, M_CACHE, M_WAITOK, &ncvhash);
#else
2000-11-08 17:28:12 +03:00
hashinit(desiredvnodes/8, HASH_LIST, M_CACHE, M_WAITOK, &ncvhash);
#endif
pool_init(&namecache_pool, sizeof(struct namecache), 0, 0, 0,
"ncachepl", 0, pool_page_alloc_nointr, pool_page_free_nointr,
M_CACHE);
1993-03-21 12:45:37 +03:00
}
/*
* Cache flush, a particular vnode; called when a vnode is renamed to
* hide entries that would now be invalid
*/
1996-02-04 05:17:43 +03:00
void
1993-03-21 12:45:37 +03:00
cache_purge(vp)
struct vnode *vp;
{
struct namecache *ncp;
struct nchashhead *ncpp;
static u_long nextvnodeid;
1993-03-21 12:45:37 +03:00
vp->v_id = ++nextvnodeid;
if (nextvnodeid != 0)
return;
1994-06-08 15:28:29 +04:00
for (ncpp = &nchashtbl[nchash]; ncpp >= nchashtbl; ncpp--) {
LIST_FOREACH(ncp, ncpp, nc_hash) {
1993-03-21 12:45:37 +03:00
ncp->nc_vpid = 0;
ncp->nc_dvpid = 0;
}
}
vp->v_id = ++nextvnodeid;
}
/*
* Cache flush, a whole filesystem; called when filesys is umounted to
* remove entries that would now be invalid.
1993-03-21 12:45:37 +03:00
*/
1996-02-04 05:17:43 +03:00
void
1993-03-21 12:45:37 +03:00
cache_purgevfs(mp)
struct mount *mp;
{
2000-03-30 13:27:11 +04:00
struct namecache *ncp, *nxtcp;
1993-03-21 12:45:37 +03:00
for (ncp = TAILQ_FIRST(&nclruhead); ncp != NULL; ncp = nxtcp) {
nxtcp = TAILQ_NEXT(ncp, nc_lru);
1994-06-08 15:28:29 +04:00
if (ncp->nc_dvp == NULL || ncp->nc_dvp->v_mount != mp) {
1993-03-21 12:45:37 +03:00
continue;
1994-06-08 15:28:29 +04:00
}
1993-03-21 12:45:37 +03:00
/* free the resources we had */
ncp->nc_vp = NULL;
ncp->nc_dvp = NULL;
TAILQ_REMOVE(&nclruhead, ncp, nc_lru);
if (ncp->nc_hash.le_prev != 0) {
LIST_REMOVE(ncp, nc_hash);
ncp->nc_hash.le_prev = 0;
1994-06-08 15:28:29 +04:00
}
if (ncp->nc_vhash.le_prev != 0) {
LIST_REMOVE(ncp, nc_vhash);
ncp->nc_vhash.le_prev = 0;
}
TAILQ_INSERT_HEAD(&nclruhead, ncp, nc_lru);
1993-03-21 12:45:37 +03:00
}
}
#ifdef DDB
void
namecache_print(struct vnode *vp, void (*pr)(const char *, ...))
{
struct vnode *dvp = NULL;
struct namecache *ncp;
TAILQ_FOREACH(ncp, &nclruhead, nc_lru) {
if (ncp->nc_vp == vp && ncp->nc_vpid == vp->v_id) {
(*pr)("name %.*s\n", ncp->nc_nlen, ncp->nc_name);
dvp = ncp->nc_dvp;
}
}
if (dvp == NULL) {
(*pr)("name not found\n");
return;
}
vp = dvp;
TAILQ_FOREACH(ncp, &nclruhead, nc_lru) {
if (ncp->nc_vp == vp && ncp->nc_vpid == vp->v_id) {
(*pr)("parent %.*s\n", ncp->nc_nlen, ncp->nc_name);
}
}
}
#endif