[BACK]Return to dirhash.h CVS log [TXT][DIR] Up to [cvs.NetBSD.org] / src / sys / ufs / ufs

Annotation of src/sys/ufs/ufs/dirhash.h, Revision 1.2.4.2

1.2.4.2 ! kent        1: /*     $NetBSD: dirhash.h,v 1.2.4.1 2005/04/29 11:29:39 kent Exp $     */
        !             2:
        !             3: /*
        !             4:  * Copyright (c) 2001 Ian Dowse.  All rights reserved.
        !             5:  *
        !             6:  * Redistribution and use in source and binary forms, with or without
        !             7:  * modification, are permitted provided that the following conditions
        !             8:  * are met:
        !             9:  * 1. Redistributions of source code must retain the above copyright
        !            10:  *    notice, this list of conditions and the following disclaimer.
        !            11:  * 2. Redistributions in binary form must reproduce the above copyright
        !            12:  *    notice, this list of conditions and the following disclaimer in the
        !            13:  *    documentation and/or other materials provided with the distribution.
        !            14:  *
        !            15:  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
        !            16:  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        !            17:  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
        !            18:  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
        !            19:  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        !            20:  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
        !            21:  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
        !            22:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
        !            23:  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
        !            24:  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
        !            25:  * SUCH DAMAGE.
        !            26:  *
        !            27:  * $FreeBSD: src/sys/ufs/ufs/dirhash.h,v 1.2.2.2 2004/12/08 11:54:13 dwmalone Exp $
        !            28:  */
        !            29:
        !            30: #ifndef _UFS_UFS_DIRHASH_H_
        !            31: #define _UFS_UFS_DIRHASH_H_
        !            32:
        !            33: /*
        !            34:  * For fast operations on large directories, we maintain a hash
        !            35:  * that maps the file name to the offset of the directory entry within
        !            36:  * the directory file.
        !            37:  *
        !            38:  * The hashing uses a dumb spillover to the next free slot on
        !            39:  * collisions, so we must keep the utilisation low to avoid
        !            40:  * long linear searches. Deleted entries that are not the last
        !            41:  * in a chain must be marked DIRHASH_DEL.
        !            42:  *
        !            43:  * We also maintain information about free space in each block
        !            44:  * to speed up creations.
        !            45:  */
        !            46: #define DIRHASH_EMPTY  (-1)    /* entry unused */
        !            47: #define DIRHASH_DEL    (-2)    /* deleted entry; may be part of chain */
        !            48:
        !            49: #define DIRALIGN       4
        !            50: #define DH_NFSTATS     (DIRECTSIZ(MAXNAMLEN + 1) / DIRALIGN)
        !            51:                                 /* max DIRALIGN words in a directory entry */
        !            52:
        !            53: /*
        !            54:  * Dirhash uses a score mechanism to achieve a hybrid between a
        !            55:  * least-recently-used and a least-often-used algorithm for entry
        !            56:  * recycling. The score is incremented when a directory is used, and
        !            57:  * decremented when the directory is a candidate for recycling. When
        !            58:  * the score reaches zero, the hash is recycled. Hashes are linked
        !            59:  * together on a TAILQ list, and hashes with higher scores filter
        !            60:  * towards the tail (most recently used) end of the list.
        !            61:  *
        !            62:  * New hash entries are given an inital score of DH_SCOREINIT and are
        !            63:  * placed at the most-recently-used end of the list. This helps a lot
        !            64:  * in the worst-case case scenario where every directory access is
        !            65:  * to a directory that is not hashed (i.e. the working set of hash
        !            66:  * candidates is much larger than the configured memry limit). In this
        !            67:  * case it limits the number of hash builds to 1/DH_SCOREINIT of the
        !            68:  * number of accesses.
        !            69:  */
        !            70: #define DH_SCOREINIT   8       /* initial dh_score when dirhash built */
        !            71: #define DH_SCOREMAX    64      /* max dh_score value */
        !            72:
        !            73: /*
        !            74:  * The main hash table has 2 levels. It is an array of pointers to
        !            75:  * blocks of DH_NBLKOFF offsets.
        !            76:  */
        !            77: #define DH_BLKOFFSHIFT 8
        !            78: #define DH_NBLKOFF     (1 << DH_BLKOFFSHIFT)
        !            79: #define DH_BLKOFFMASK  (DH_NBLKOFF - 1)
        !            80:
        !            81: #define DH_ENTRY(dh, slot) \
        !            82:     ((dh)->dh_hash[(slot) >> DH_BLKOFFSHIFT][(slot) & DH_BLKOFFMASK])
        !            83:
        !            84: struct dirhash {
        !            85:        doff_t  **dh_hash;      /* the hash array (2-level) */
        !            86:        int     dh_narrays;     /* number of entries in dh_hash */
        !            87:        int     dh_hlen;        /* total slots in the 2-level hash array */
        !            88:        int     dh_hused;       /* entries in use */
        !            89:
        !            90:        u_int8_t *dh_blkfree;   /* free DIRALIGN words in each dir block */
        !            91:        int     dh_nblk;        /* size of dh_blkfree array */
        !            92:        int     dh_dirblks;     /* number of DIRBLKSIZ blocks in dir */
        !            93:        int     dh_firstfree[DH_NFSTATS + 1]; /* first blk with N words free */
        !            94:
        !            95:        int     dh_seqopt;      /* sequential access optimisation enabled */
        !            96:        doff_t  dh_seqoff;      /* sequential access optimisation offset */
        !            97:
        !            98:        int     dh_score;       /* access count for this dirhash */
        !            99:
        !           100:        int     dh_onlist;      /* true if on the ufsdirhash_list chain */
        !           101:
        !           102:        TAILQ_ENTRY(dirhash) dh_list;   /* chain of all dirhashes */
        !           103: };
        !           104:
        !           105:
        !           106: /*
        !           107:  * Dirhash functions.
        !           108:  */
        !           109: int    ufsdirhash_build(struct inode *);
        !           110: doff_t ufsdirhash_findfree(struct inode *, int, int *);
        !           111: doff_t ufsdirhash_enduseful(struct inode *);
        !           112: int    ufsdirhash_lookup(struct inode *, const char *, int, doff_t *,
        !           113:            struct buf **, doff_t *);
        !           114: void   ufsdirhash_newblk(struct inode *, doff_t);
        !           115: void   ufsdirhash_add(struct inode *, struct direct *, doff_t);
        !           116: void   ufsdirhash_remove(struct inode *, struct direct *, doff_t);
        !           117: void   ufsdirhash_move(struct inode *, struct direct *, doff_t, doff_t);
        !           118: void   ufsdirhash_dirtrunc(struct inode *, doff_t);
        !           119: void   ufsdirhash_free(struct inode *);
        !           120: void   ufsdirhash_checkblock(struct inode *, char *, doff_t);
        !           121: void   ufsdirhash_init(void);
        !           122: void   ufsdirhash_done(void);
        !           123:
        !           124: #endif /* !_UFS_UFS_DIRHASH_H_ */

CVSweb <webmaster@jp.NetBSD.org>