sys/gnu/vfs/ext2fs/fs.h

   1 /*
   2  *  modified for EXT2FS support in Lites 1.1
   3  *
   4  *  Aug 1995, Godmar Back (gback@cs.utah.edu)
   5  *  University of Utah, Department of Computer Science
   6  */
   7 /*
   8  * Copyright (c) 1982, 1986, 1993
   9  *      The Regents of the University of California.  All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  *      @(#)fs.h        8.7 (Berkeley) 4/19/94
  40  * $FreeBSD: src/sys/gnu/ext2fs/fs.h,v 1.5.2.1 2000/11/11 13:12:45 bde Exp $
  41  */
  42
  43 /*
  44  * Each disk drive contains some number of file systems.
  45  * A file system consists of a number of block groups.
  46  * Each block group has inodes and data.
  47  *
  48  * A file system is described by its super-block, which in turn
  49  * describes the block groups.  The super-block is critical
  50  * data and is replicated in each block group to protect against
  51  * catastrophic loss.  This is done at `newfs' time and the critical
  52  * super-block data does not change, so the copies need not be
  53  * referenced further unless disaster strikes.
  54  *
  55  * The first boot and super blocks are given in absolute disk addresses.
  56  * The byte-offset forms are preferred, as they don't imply a sector size.
  57  */
  58
  59 #ifndef _LINUX_EXT2_FS_FS
  60 #define _LINUX_EXT2_FS_FS
  61
  62 #define BBSIZE          1024
  63 #define SBSIZE          1024
  64 #define BBOFF           ((off_t)(0))
  65 #define SBOFF           ((off_t)(BBOFF + BBSIZE))
  66 #define BBLOCK          ((daddr_t)(0))
  67 #define SBLOCK          ((daddr_t)(BBLOCK + BBSIZE / DEV_BSIZE))
  68
  69 /*
  70  * The path name on which the file system is mounted is maintained
  71  * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in
  72  * the super block for this name.
  73  */
  74 #define MAXMNTLEN 512
  75
  76 /*
  77  * Macros for access to superblock array structures
  78  */
  79
  80 /*
  81  * Convert block group to base address of its global summary info.
  82  */
  83 #define fs_cs(fs, cgindx)      (((struct ext2_group_desc *) \
  84         (fs->s_group_desc[cgindx / EXT2_DESC_PER_BLOCK(fs)]->b_data)) \
  85                 [cgindx % EXT2_DESC_PER_BLOCK(fs)])
  86
  87 /*
  88  * Turn file system block numbers into disk block addresses.
  89  * This maps file system blocks to device size blocks.
  90  */
  91 #define fsbtodb(fs, b)  ((b) << ((fs)->s_fsbtodb))
  92 #define dbtofsb(fs, b)  ((b) >> ((fs)->s_fsbtodb))
  93
  94 /* get group containing inode */
  95 #define ino_to_cg(fs, x)        (((x) - 1) / EXT2_INODES_PER_GROUP(fs))
  96
  97 /* get block containing inode from its number x */
  98 #define ino_to_fsba(fs, x)      (fs_cs(fs, ino_to_cg(fs, x)).bg_inode_table + \
  99         (((x)-1) % EXT2_INODES_PER_GROUP(fs))/EXT2_INODES_PER_BLOCK(fs))
 100
 101 /* get offset for inode in block */
 102 #define ino_to_fsbo(fs, x)      ((x-1) % EXT2_INODES_PER_BLOCK(fs))
 103
 104 /*
 105  * Give block group number for a file system block.
 106  * Give block group block number for a file system block.
 107  */
 108 #define dtog(fs, d)     (((d) - fs->s_es->s_first_data_block) / \
 109                         EXT2_BLOCKS_PER_GROUP(fs))
 110 #define dtogd(fs, d)    (((d) - fs->s_es->s_first_data_block) % \
 111                         EXT2_BLOCKS_PER_GROUP(fs))
 112
 113 /*
 114  * The following macros optimize certain frequently calculated
 115  * quantities by using shifts and masks in place of divisions
 116  * modulos and multiplications.
 117  */
 118 #define blkoff(fs, loc)         /* calculates (loc % fs->fs_bsize) */ \
 119         ((loc) & (fs)->s_qbmask)
 120
 121 #define lblktosize(fs, blk)     /* calculates (blk * fs->fs_bsize) */ \
 122         ((blk) << (fs->s_bshift))
 123
 124 /*
 125  * Used when converting logical blocks to offsets for getblk, bread,
 126  * etc.
 127  */
 128 #define lblktodoff(fs, blk)     /* calculates (blk * fs->fs_bsize) */ \
 129         ((off_t)(blk) << (fs)->s_bshift)
 130 #define fsbtodoff(fs, blk)      /* calculates (blk * fs->fs_fsize) */ \
 131         ((off_t)(blk) * (fs)->s_frag_size)
 132 #define dofftofsb(fs, blk)      /* calculates blk / fs->fs_fsize */   \
 133         ((daddr_t)((blk) / (fs)->s_frag_size))
 134 #define dbtodoff(fs, b)         /* calculates diskblk * sectorsize */ \
 135         ((off_t)(b) * ((fs)->s_frag_size >> (fs)->s_fsbtodb))
 136
 137 #define lblkno(fs, loc)         /* calculates (loc / fs->fs_bsize) */ \
 138         ((loc) >> (fs->s_bshift))
 139
 140 /* no fragments -> logical block number equal # of frags */
 141 #define numfrags(fs, loc)       /* calculates (loc / fs->fs_fsize) */ \
 142         ((loc) >> (fs->s_bshift))
 143
 144 #define fragroundup(fs, size)   /* calculates roundup(size, fs->fs_fsize) */ \
 145         roundup(size, fs->s_frag_size)
 146         /* was (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask) */
 147
 148 /*
 149  * Determining the size of a file block in the file system.
 150  * easy w/o fragments
 151  */
 152 #define blksize(fs, ip, lbn) ((fs)->s_frag_size)
 153
 154 /*
 155  * INOPB is the number of inodes in a secondary storage block.
 156  */
 157 #define INOPB(fs)       EXT2_INODES_PER_BLOCK(fs)
 158
 159 /*
 160  * NINDIR is the number of indirects in a file system block.
 161  */
 162 #define NINDIR(fs)      (EXT2_ADDR_PER_BLOCK(fs))
 163
 164 extern int inside[], around[];
 165 extern u_char *fragtbl[];
 166
 167 /* a few remarks about superblock locking/unlocking
 168  * Linux provides special routines for doing so
 169  * I haven't figured out yet what BSD does
 170  * I think I'll try a vn_lock/vn_unlock on the device vnode
 171  */
 172 #define  DEVVP(inode)           (VFSTOEXT2(ITOV(inode)->v_mount)->um_devvp)
 173 #define  lock_super(devvp)      \
 174                 vn_lock(devvp, LK_EXCLUSIVE | LK_RETRY | LK_FAILRECLAIM)
 175 #define  unlock_super(devvp)    vn_unlock(devvp)
 176
 177 /*
 178  * To lock a buffer, set the B_LOCKED flag and then brelse() it. To unlock,
 179  * reset the B_LOCKED flag and brelse() the buffer back on the LRU list
 180  */
 181 #define LCK_BUF(bp) { \
 182         crit_enter(); \
 183         (bp)->b_flags |= B_LOCKED; \
 184         crit_exit(); \
 185         brelse(bp); \
 186 }
 187
 188 #define ULCK_BUF(bp) { \
 189         long flags; \
 190         crit_enter(); \
 191         flags = (bp)->b_flags; \
 192         (bp)->b_flags &= ~(B_DIRTY | B_LOCKED); \
 193         BUF_LOCK(bp, LK_EXCLUSIVE); \
 194         bremfree(bp); \
 195         crit_exit(); \
 196         if (flags & B_DIRTY) \
 197                 bwrite(bp); \
 198         else \
 199                 brelse(bp); \
 200 }
 201
 202 #endif /* _LINUX_EXT2_FS_FS */