sys/vfs/ufs/fs.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)fs.h        8.13 (Berkeley) 3/21/95
  34  * $FreeBSD: src/sys/ufs/ffs/fs.h,v 1.14.2.3 2001/09/21 19:15:22 dillon Exp $
  35  * $DragonFly: src/sys/vfs/ufs/fs.h,v 1.3 2004/07/18 19:43:48 drhodus Exp $
  36  */
  37
  38 #ifndef _UFS_FFS_FS_H_
  39 #define _UFS_FFS_FS_H_
  40
  41 /*
  42  * Each disk drive contains some number of filesystems.
  43  * A filesystem consists of a number of cylinder groups.
  44  * Each cylinder group has inodes and data.
  45  *
  46  * A filesystem is described by its super-block, which in turn
  47  * describes the cylinder groups.  The super-block is critical
  48  * data and is replicated in each cylinder group to protect against
  49  * catastrophic loss.  This is done at `newfs' time and the critical
  50  * super-block data does not change, so the copies need not be
  51  * referenced further unless disaster strikes.
  52  *
  53  * For filesystem fs, the offsets of the various blocks of interest
  54  * are given in the super block as:
  55  *      [fs->fs_sblkno]         Super-block
  56  *      [fs->fs_cblkno]         Cylinder group block
  57  *      [fs->fs_iblkno]         Inode blocks
  58  *      [fs->fs_dblkno]         Data blocks
  59  * The beginning of cylinder group cg in fs, is given by
  60  * the ``cgbase(fs, cg)'' macro.
  61  *
  62  * The first boot and super blocks are given in absolute disk addresses.
  63  * The byte-offset forms are preferred, as they don't imply a sector size.
  64  */
  65 #define BBSIZE          8192
  66 #define SBSIZE          8192
  67 #define BBOFF           ((off_t)(0))
  68 #define SBOFF           ((off_t)(BBOFF + BBSIZE))
  69 #define BBLOCK          ((ufs_daddr_t)(0))
  70 #define SBLOCK          ((ufs_daddr_t)(BBLOCK + BBSIZE / DEV_BSIZE))
  71
  72 /*
  73  * Addresses stored in inodes are capable of addressing fragments
  74  * of `blocks'. Filesystem blocks of at most size MAXBSIZE can
  75  * be optionally broken into 2, 4, or 8 pieces, each of which is
  76  * addressable; these pieces may be DEV_BSIZE, or some multiple of
  77  * a DEV_BSIZE unit.
  78  *
  79  * Large files consist of exclusively large data blocks.  To avoid
  80  * undue wasted disk space, the last data block of a small file may be
  81  * allocated as only as many fragments of a large block as are
  82  * necessary.  The filesystem format retains only a single pointer
  83  * to such a fragment, which is a piece of a single large block that
  84  * has been divided.  The size of such a fragment is determinable from
  85  * information in the inode, using the ``blksize(fs, ip, lbn)'' macro.
  86  *
  87  * The filesystem records space availability at the fragment level;
  88  * to determine block availability, aligned fragments are examined.
  89  */
  90
  91 /*
  92  * MINBSIZE is the smallest allowable block size.
  93  * In order to insure that it is possible to create files of size
  94  * 2^32 with only two levels of indirection, MINBSIZE is set to 4096.
  95  * MINBSIZE must be big enough to hold a cylinder group block,
  96  * thus changes to (struct cg) must keep its size within MINBSIZE.
  97  * Note that super blocks are always of size SBSIZE,
  98  * and that both SBSIZE and MAXBSIZE must be >= MINBSIZE.
  99  */
 100 #define MINBSIZE        4096
 101
 102 /*
 103  * The path name on which the filesystem is mounted is maintained
 104  * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in
 105  * the super block for this name.
 106  */
 107 #define MAXMNTLEN       512
 108
 109 /*
 110  * There is a 128-byte region in the superblock reserved for in-core
 111  * pointers to summary information. Originally this included an array
 112  * of pointers to blocks of struct csum; now there are just three
 113  * pointers and the remaining space is padded with fs_ocsp[].
 114  *
 115  * NOCSPTRS determines the size of this padding. One pointer (fs_csp)
 116  * is taken away to point to a contiguous array of struct csum for
 117  * all cylinder groups; a second (fs_maxcluster) points to an array
 118  * of cluster sizes that is computed as cylinder groups are inspected,
 119  * and the third points to an array that tracks the creation of new
 120  * directories.
 121  */
 122 #define NOCSPTRS        ((128 / sizeof(void *)) - 3)
 123
 124 /*
 125  * A summary of contiguous blocks of various sizes is maintained
 126  * in each cylinder group. Normally this is set by the initial
 127  * value of fs_maxcontig. To conserve space, a maximum summary size
 128  * is set by FS_MAXCONTIG.
 129  */
 130 #define FS_MAXCONTIG    16
 131
 132 /*
 133  * MINFREE gives the minimum acceptable percentage of filesystem
 134  * blocks which may be free. If the freelist drops below this level
 135  * only the superuser may continue to allocate blocks. This may
 136  * be set to 0 if no reserve of free blocks is deemed necessary,
 137  * however throughput drops by fifty percent if the filesystem
 138  * is run at between 95% and 100% full; thus the minimum default
 139  * value of fs_minfree is 5%. However, to get good clustering
 140  * performance, 10% is a better choice. hence we use 10% as our
 141  * default value. With 10% free space, fragmentation is not a
 142  * problem, so we choose to optimize for time.
 143  */
 144 #define MINFREE         8
 145 #define DEFAULTOPT      FS_OPTTIME
 146
 147 /*
 148  * Grigoriy Orlov <gluk@ptci.ru> has done some extensive work to fine
 149  * tune the layout preferences for directories within a filesystem.
 150  * His algorithm can be tuned by adjusting the following parameters
 151  * which tell the system the average file size and the average number
 152  * of files per directory. These defaults are well selected for typical
 153  * filesystems, but may need to be tuned for odd cases like filesystems
 154  * being used for squid caches or news spools.
 155  */
 156 #define AVFILESIZ      16384   /* expected average file size */
 157 #define AFPDIR         64      /* expected number of files per directory */
 158
 159 /*
 160  * The maximum number of snapshot nodes that can be associated
 161  * with each filesystem. This limit affects only the number of
 162  * snapshot files that can be recorded within the superblock so
 163  * that they can be found when the filesystem is mounted. However,
 164  * maintaining too many will slow the filesystem performance, so
 165  * having this limit is a good idea.
 166  *
 167  * VALUE NOT IMPLEMENTED IN DragonFly(and very unlikely to ever be as there are
 168  * much better options such as journaling), RESERVED FROM FreeBSD 5.x SO
 169  * SUPERBLOCKS REMAIN COMPATIBLE FOR THE TIME BEING. WHY ARE WE YELLING ?
 170  */
 171 #define FSMAXSNAP 20
 172
 173 /*
 174  * Per cylinder group information; summarized in blocks allocated
 175  * from first cylinder group data blocks.  These blocks have to be
 176  * read in from fs_csaddr (size fs_cssize) in addition to the
 177  * super block.
 178  */
 179 struct csum {
 180         int32_t cs_ndir;                /* number of directories */
 181         int32_t cs_nbfree;              /* number of free blocks */
 182         int32_t cs_nifree;              /* number of free inodes */
 183         int32_t cs_nffree;              /* number of free frags */
 184 };
 185
 186 /*
 187  * Super block for an FFS filesystem.
 188  */
 189 struct fs {
 190         int32_t  fs_firstfield;         /* historic filesystem linked list, */
 191         int32_t  fs_unused_1;           /*     used for incore super blocks */
 192         ufs_daddr_t fs_sblkno;          /* addr of super-block in filesys */
 193         ufs_daddr_t fs_cblkno;          /* offset of cyl-block in filesys */
 194         ufs_daddr_t fs_iblkno;          /* offset of inode-blocks in filesys */
 195         ufs_daddr_t fs_dblkno;          /* offset of first data after cg */
 196         int32_t  fs_cgoffset;           /* cylinder group offset in cylinder */
 197         int32_t  fs_cgmask;             /* used to calc mod fs_ntrak */
 198         time_t   fs_time;               /* last time written */
 199         int32_t  fs_size;               /* number of blocks in fs */
 200         int32_t  fs_dsize;              /* number of data blocks in fs */
 201         int32_t  fs_ncg;                /* number of cylinder groups */
 202         int32_t  fs_bsize;              /* size of basic blocks in fs */
 203         int32_t  fs_fsize;              /* size of frag blocks in fs */
 204         int32_t  fs_frag;               /* number of frags in a block in fs */
 205 /* these are configuration parameters */
 206         int32_t  fs_minfree;            /* minimum percentage of free blocks */
 207         int32_t  fs_rotdelay;           /* num of ms for optimal next block */
 208         int32_t  fs_rps;                /* disk revolutions per second */
 209 /* these fields can be computed from the others */
 210         int32_t  fs_bmask;              /* ``blkoff'' calc of blk offsets */
 211         int32_t  fs_fmask;              /* ``fragoff'' calc of frag offsets */
 212         int32_t  fs_bshift;             /* ``lblkno'' calc of logical blkno */
 213         int32_t  fs_fshift;             /* ``numfrags'' calc number of frags */
 214 /* these are configuration parameters */
 215         int32_t  fs_maxcontig;          /* max number of contiguous blks */
 216         int32_t  fs_maxbpg;             /* max number of blks per cyl group */
 217 /* these fields can be computed from the others */
 218         int32_t  fs_fragshift;          /* block to frag shift */
 219         int32_t  fs_fsbtodb;            /* fsbtodb and dbtofsb shift constant */
 220         int32_t  fs_sbsize;             /* actual size of super block */
 221         int32_t  fs_csmask;             /* csum block offset (now unused) */
 222         int32_t  fs_csshift;            /* csum block number (now unused) */
 223         int32_t  fs_nindir;             /* value of NINDIR */
 224         int32_t  fs_inopb;              /* value of INOPB */
 225         int32_t  fs_nspf;               /* value of NSPF */
 226 /* yet another configuration parameter */
 227         int32_t  fs_optim;              /* optimization preference, see below */
 228 /* these fields are derived from the hardware */
 229         int32_t  fs_npsect;             /* # sectors/track including spares */
 230         int32_t  fs_interleave;         /* hardware sector interleave */
 231         int32_t  fs_trackskew;          /* sector 0 skew, per track */
 232 /* fs_id takes the space of the unused fs_headswitch and fs_trkseek fields */
 233         int32_t  fs_id[2];              /* unique filesystem id */
 234 /* sizes determined by number of cylinder groups and their sizes */
 235         ufs_daddr_t fs_csaddr;          /* blk addr of cyl grp summary area */
 236         int32_t  fs_cssize;             /* size of cyl grp summary area */
 237         int32_t  fs_cgsize;             /* cylinder group size */
 238 /* these fields are derived from the hardware */
 239         int32_t  fs_ntrak;              /* tracks per cylinder */
 240         int32_t  fs_nsect;              /* sectors per track */
 241         int32_t  fs_spc;                        /* sectors per cylinder */
 242 /* this comes from the disk driver partitioning */
 243         int32_t  fs_ncyl;               /* cylinders in filesystem */
 244 /* these fields can be computed from the others */
 245         int32_t  fs_cpg;                        /* cylinders per group */
 246         int32_t  fs_ipg;                        /* inodes per group */
 247         int32_t  fs_fpg;                        /* blocks per group * fs_frag */
 248 /* this data must be re-computed after crashes */
 249         struct  csum fs_cstotal;        /* cylinder summary information */
 250 /* these fields are cleared at mount time */
 251         int8_t   fs_fmod;               /* super block modified flag */
 252         int8_t   fs_clean;              /* filesystem is clean flag */
 253         int8_t   fs_ronly;              /* mounted read-only flag */
 254         int8_t   fs_flags;              /* see FS_ flags below */
 255         u_char   fs_fsmnt[MAXMNTLEN];   /* name mounted on */
 256 /* these fields retain the current block allocation info */
 257         int32_t  fs_cgrotor;            /* last cg searched */
 258         void    *fs_ocsp[NOCSPTRS];     /* padding; was list of fs_cs buffers */
 259         uint8_t *fs_contigdirs; /* # of contiguously allocated dirs */
 260         struct csum *fs_csp;            /* cg summary info buffer for fs_cs */
 261         int32_t *fs_maxcluster;         /* max cluster in each cyl group */
 262         int32_t  fs_cpc;                /* cyl per cycle in postbl */
 263         int16_t  fs_opostbl[16][8];     /* old rotation block list head */
 264         int32_t  fs_snapinum[FSMAXSNAP];/* RESERVED FROM 5.x */
 265         int32_t  fs_avgfilesize;        /* expected average file size */
 266         int32_t  fs_avgfpdir;           /* expected # of files per directory */
 267         int32_t  fs_sparecon[26];       /* reserved for future constants */
 268         int32_t  fs_pendingblocks;      /* RESERVED FROM 5.x */
 269         int32_t  fs_pendinginodes;      /* RESERVED FROM 5.x */
 270         int32_t  fs_contigsumsize;      /* size of cluster summary array */
 271         int32_t  fs_maxsymlinklen;      /* max length of an internal symlink */
 272         int32_t  fs_inodefmt;           /* format of on-disk inodes */
 273         uint64_t fs_maxfilesize;        /* maximum representable file size */
 274         int64_t  fs_qbmask;             /* ~fs_bmask for use with 64-bit size */
 275         int64_t  fs_qfmask;             /* ~fs_fmask for use with 64-bit size */
 276         int32_t  fs_state;              /* validate fs_clean field */
 277         int32_t  fs_postblformat;       /* format of positional layout tables */
 278         int32_t  fs_nrpos;              /* number of rotational positions */
 279         int32_t  fs_postbloff;          /* (uint16) rotation block list head */
 280         int32_t  fs_rotbloff;           /* (uint8) blocks for each rotation */
 281         int32_t  fs_magic;              /* magic number */
 282         uint8_t fs_space[1];            /* list of blocks for each rotation */
 283 /* actually longer */
 284 };
 285
 286 /*
 287  * Filesystem identification
 288  */
 289 #define FS_MAGIC        0x011954        /* the fast filesystem magic number */
 290 #define FS_OKAY         0x7c269d38      /* superblock checksum */
 291 #define FS_42INODEFMT   -1              /* 4.2BSD inode format */
 292 #define FS_44INODEFMT   2               /* 4.4BSD inode format */
 293
 294 /*
 295  * Preference for optimization.
 296  */
 297 #define FS_OPTTIME      0       /* minimize allocation time */
 298 #define FS_OPTSPACE     1       /* minimize disk fragmentation */
 299
 300 /*
 301  * Filesystem flags.
 302  */
 303 #define FS_UNCLEAN    0x01    /* filesystem not clean at mount */
 304 #define FS_DOSOFTDEP  0x02    /* filesystem using soft dependencies */
 305
 306 /*
 307  * Rotational layout table format types
 308  */
 309 #define FS_42POSTBLFMT          -1      /* 4.2BSD rotational table format */
 310 #define FS_DYNAMICPOSTBLFMT     1       /* dynamic rotational table format */
 311 /*
 312  * Macros for access to superblock array structures
 313  */
 314 #define fs_postbl(fs, cylno) \
 315     (((fs)->fs_postblformat == FS_42POSTBLFMT) \
 316     ? ((fs)->fs_opostbl[cylno]) \
 317     : ((int16_t *)((uint8_t *)(fs) + \
 318         (fs)->fs_postbloff) + (cylno) * (fs)->fs_nrpos))
 319 #define fs_rotbl(fs) \
 320     (((fs)->fs_postblformat == FS_42POSTBLFMT) \
 321     ? ((fs)->fs_space) \
 322     : ((uint8_t *)((uint8_t *)(fs) + (fs)->fs_rotbloff)))
 323
 324 /*
 325  * The size of a cylinder group is calculated by CGSIZE. The maximum size
 326  * is limited by the fact that cylinder groups are at most one block.
 327  * Its size is derived from the size of the maps maintained in the
 328  * cylinder group and the (struct cg) size.
 329  */
 330 #define CGSIZE(fs) \
 331     /* base cg */       (sizeof(struct cg) + sizeof(int32_t) + \
 332     /* blktot size */   (fs)->fs_cpg * sizeof(int32_t) + \
 333     /* blks size */     (fs)->fs_cpg * (fs)->fs_nrpos * sizeof(int16_t) + \
 334     /* inode map */     howmany((fs)->fs_ipg, NBBY) + \
 335     /* block map */     howmany((fs)->fs_cpg * (fs)->fs_spc / NSPF(fs), NBBY) +\
 336     /* if present */    ((fs)->fs_contigsumsize <= 0 ? 0 : \
 337     /* cluster sum */   (fs)->fs_contigsumsize * sizeof(int32_t) + \
 338     /* cluster map */   howmany((fs)->fs_cpg * (fs)->fs_spc / NSPB(fs), NBBY)))
 339
 340 /*
 341  * Convert cylinder group to base address of its global summary info.
 342  */
 343 #define fs_cs(fs, indx) fs_csp[indx]
 344
 345 /*
 346  * Cylinder group block for a filesystem.
 347  */
 348 #define CG_MAGIC        0x090255
 349 struct cg {
 350         int32_t  cg_firstfield;         /* historic cyl groups linked list */
 351         int32_t  cg_magic;              /* magic number */
 352         time_t   cg_time;               /* time last written */
 353         int32_t  cg_cgx;                /* we are the cgx'th cylinder group */
 354         int16_t  cg_ncyl;               /* number of cyl's this cg */
 355         int16_t  cg_niblk;              /* number of inode blocks this cg */
 356         int32_t  cg_ndblk;              /* number of data blocks this cg */
 357         struct  csum cg_cs;             /* cylinder summary information */
 358         int32_t  cg_rotor;              /* position of last used block */
 359         int32_t  cg_frotor;             /* position of last used frag */
 360         int32_t  cg_irotor;             /* position of last used inode */
 361         int32_t  cg_frsum[MAXFRAG];     /* counts of available frags */
 362         int32_t  cg_btotoff;            /* (int32) block totals per cylinder */
 363         int32_t  cg_boff;               /* (uint16) free block positions */
 364         int32_t  cg_iusedoff;           /* (uint8) used inode map */
 365         int32_t  cg_freeoff;            /* (uint8) free block map */
 366         int32_t  cg_nextfreeoff;        /* (uint8) next available space */
 367         int32_t  cg_clustersumoff;      /* (uint32) counts of avail clusters */
 368         int32_t  cg_clusteroff;         /* (uint8) free cluster map */
 369         int32_t  cg_nclusterblks;       /* number of clusters this cg */
 370         int32_t  cg_sparecon[13];       /* reserved for future use */
 371         uint8_t cg_space[1];            /* space for cylinder group maps */
 372 /* actually longer */
 373 };
 374
 375 /*
 376  * Macros for access to cylinder group array structures
 377  */
 378 #define cg_blktot(cgp) \
 379     (((cgp)->cg_magic != CG_MAGIC) \
 380     ? (((struct ocg *)(cgp))->cg_btot) \
 381     : ((int32_t *)((uint8_t *)(cgp) + (cgp)->cg_btotoff)))
 382 #define cg_blks(fs, cgp, cylno) \
 383     (((cgp)->cg_magic != CG_MAGIC) \
 384     ? (((struct ocg *)(cgp))->cg_b[cylno]) \
 385     : ((int16_t *)((uint8_t *)(cgp) + \
 386         (cgp)->cg_boff) + (cylno) * (fs)->fs_nrpos))
 387 #define cg_inosused(cgp) \
 388     (((cgp)->cg_magic != CG_MAGIC) \
 389     ? (((struct ocg *)(cgp))->cg_iused) \
 390     : ((uint8_t *)((uint8_t *)(cgp) + (cgp)->cg_iusedoff)))
 391 #define cg_blksfree(cgp) \
 392     (((cgp)->cg_magic != CG_MAGIC) \
 393     ? (((struct ocg *)(cgp))->cg_free) \
 394     : ((uint8_t *)((uint8_t *)(cgp) + (cgp)->cg_freeoff)))
 395 #define cg_chkmagic(cgp) \
 396     ((cgp)->cg_magic == CG_MAGIC || ((struct ocg *)(cgp))->cg_magic == CG_MAGIC)
 397 #define cg_clustersfree(cgp) \
 398     ((uint8_t *)((uint8_t *)(cgp) + (cgp)->cg_clusteroff))
 399 #define cg_clustersum(cgp) \
 400     ((int32_t *)((uint8_t *)(cgp) + (cgp)->cg_clustersumoff))
 401
 402 /*
 403  * The following structure is defined
 404  * for compatibility with old filesystems.
 405  */
 406 struct ocg {
 407         int32_t  cg_firstfield;         /* historic linked list of cyl groups */
 408         int32_t  cg_unused_1;           /*     used for incore cyl groups */
 409         time_t   cg_time;               /* time last written */
 410         int32_t  cg_cgx;                /* we are the cgx'th cylinder group */
 411         int16_t  cg_ncyl;               /* number of cyl's this cg */
 412         int16_t  cg_niblk;              /* number of inode blocks this cg */
 413         int32_t  cg_ndblk;              /* number of data blocks this cg */
 414         struct  csum cg_cs;             /* cylinder summary information */
 415         int32_t  cg_rotor;              /* position of last used block */
 416         int32_t  cg_frotor;             /* position of last used frag */
 417         int32_t  cg_irotor;             /* position of last used inode */
 418         int32_t  cg_frsum[8];           /* counts of available frags */
 419         int32_t  cg_btot[32];           /* block totals per cylinder */
 420         int16_t  cg_b[32][8];           /* positions of free blocks */
 421         uint8_t cg_iused[256];          /* used inode map */
 422         int32_t  cg_magic;              /* magic number */
 423         uint8_t cg_free[1];             /* free block map */
 424 /* actually longer */
 425 };
 426
 427 /*
 428  * Turn filesystem block numbers into disk block addresses.
 429  * This maps filesystem blocks to device size blocks.
 430  */
 431 #define fsbtodb(fs, b)  ((b) << (fs)->fs_fsbtodb)
 432 #define dbtofsb(fs, b)  ((b) >> (fs)->fs_fsbtodb)
 433
 434 /*
 435  * Cylinder group macros to locate things in cylinder groups.
 436  * They calc filesystem addresses of cylinder group data structures.
 437  */
 438 #define cgbase(fs, c)   ((ufs_daddr_t)((fs)->fs_fpg * (c)))
 439 #define cgdmin(fs, c)   (cgstart(fs, c) + (fs)->fs_dblkno)      /* 1st data */
 440 #define cgimin(fs, c)   (cgstart(fs, c) + (fs)->fs_iblkno)      /* inode blk */
 441 #define cgsblock(fs, c) (cgstart(fs, c) + (fs)->fs_sblkno)      /* super blk */
 442 #define cgtod(fs, c)    (cgstart(fs, c) + (fs)->fs_cblkno)      /* cg block */
 443 #define cgstart(fs, c)                                                  \
 444         (cgbase(fs, c) + (fs)->fs_cgoffset * ((c) & ~((fs)->fs_cgmask)))
 445
 446 /*
 447  * Macros for handling inode numbers:
 448  *     inode number to filesystem block offset.
 449  *     inode number to cylinder group number.
 450  *     inode number to filesystem block address.
 451  */
 452 #define ino_to_cg(fs, x)        ((x) / (fs)->fs_ipg)
 453 #define ino_to_fsba(fs, x)                                              \
 454         ((ufs_daddr_t)(cgimin(fs, ino_to_cg(fs, x)) +                   \
 455             (blkstofrags((fs), (((x) % (fs)->fs_ipg) / INOPB(fs))))))
 456 #define ino_to_fsbo(fs, x)      ((x) % INOPB(fs))
 457
 458 /*
 459  * Give cylinder group number for a filesystem block.
 460  * Give cylinder group block number for a filesystem block.
 461  */
 462 #define dtog(fs, d)     ((d) / (fs)->fs_fpg)
 463 #define dtogd(fs, d)    ((d) % (fs)->fs_fpg)
 464
 465 /*
 466  * Extract the bits for a block from a map.
 467  * Compute the cylinder and rotational position of a cyl block addr.
 468  */
 469 #define blkmap(fs, map, loc) \
 470     (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag)))
 471 #define cbtocylno(fs, bno) \
 472     ((bno) * NSPF(fs) / (fs)->fs_spc)
 473 #define cbtorpos(fs, bno) \
 474     (((bno) * NSPF(fs) % (fs)->fs_spc / (fs)->fs_nsect * (fs)->fs_trackskew + \
 475      (bno) * NSPF(fs) % (fs)->fs_spc % (fs)->fs_nsect * (fs)->fs_interleave) % \
 476      (fs)->fs_nsect * (fs)->fs_nrpos / (fs)->fs_npsect)
 477
 478 /*
 479  * The following macros optimize certain frequently calculated
 480  * quantities by using shifts and masks in place of divisions
 481  * modulos and multiplications.
 482  */
 483 #define blkoff(fs, loc)         /* calculates (loc % fs->fs_bsize) */ \
 484         ((loc) & (fs)->fs_qbmask)
 485 #define fragoff(fs, loc)        /* calculates (loc % fs->fs_fsize) */ \
 486         ((loc) & (fs)->fs_qfmask)
 487 #define lblktosize(fs, blk)     /* calculates ((off_t)blk * fs->fs_bsize) */ \
 488         ((off_t)(blk) << (fs)->fs_bshift)
 489 /* Use this only when `blk' is known to be small, e.g., < NDADDR. */
 490 #define smalllblktosize(fs, blk)    /* calculates (blk * fs->fs_bsize) */ \
 491         ((blk) << (fs)->fs_bshift)
 492 #define lblkno(fs, loc)         /* calculates (loc / fs->fs_bsize) */ \
 493         ((loc) >> (fs)->fs_bshift)
 494 #define numfrags(fs, loc)       /* calculates (loc / fs->fs_fsize) */ \
 495         ((loc) >> (fs)->fs_fshift)
 496 #define blkroundup(fs, size)    /* calculates roundup(size, fs->fs_bsize) */ \
 497         (((size) + (fs)->fs_qbmask) & (fs)->fs_bmask)
 498 #define fragroundup(fs, size)   /* calculates roundup(size, fs->fs_fsize) */ \
 499         (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask)
 500 #define fragstoblks(fs, frags)  /* calculates (frags / fs->fs_frag) */ \
 501         ((frags) >> (fs)->fs_fragshift)
 502 #define blkstofrags(fs, blks)   /* calculates (blks * fs->fs_frag) */ \
 503         ((blks) << (fs)->fs_fragshift)
 504 #define fragnum(fs, fsb)        /* calculates (fsb % fs->fs_frag) */ \
 505         ((fsb) & ((fs)->fs_frag - 1))
 506 #define blknum(fs, fsb)         /* calculates rounddown(fsb, fs->fs_frag) */ \
 507         ((fsb) &~ ((fs)->fs_frag - 1))
 508
 509 /*
 510  * Determine the number of available frags given a
 511  * percentage to hold in reserve.
 512  */
 513 #define freespace(fs, percentreserved) \
 514         (blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \
 515         (fs)->fs_cstotal.cs_nffree - \
 516         ((off_t)((fs)->fs_dsize) * (percentreserved) / 100))
 517
 518 /*
 519  * Determining the size of a file block in the filesystem.
 520  */
 521 #define blksize(fs, ip, lbn) \
 522         (((lbn) >= NDADDR || (ip)->i_size >= smalllblktosize(fs, (lbn) + 1)) \
 523             ? (fs)->fs_bsize \
 524             : (fragroundup(fs, blkoff(fs, (ip)->i_size))))
 525 #define dblksize(fs, dip, lbn) \
 526         (((lbn) >= NDADDR || (dip)->di_size >= smalllblktosize(fs, (lbn) + 1)) \
 527             ? (fs)->fs_bsize \
 528             : (fragroundup(fs, blkoff(fs, (dip)->di_size))))
 529 #define sblksize(fs, size, lbn) \
 530         (((lbn) >= NDADDR || (size) >= ((lbn) + 1) << (fs)->fs_bshift) \
 531           ? (fs)->fs_bsize \
 532           : (fragroundup(fs, blkoff(fs, (size)))))
 533
 534
 535 /*
 536  * Number of disk sectors per block/fragment; assumes DEV_BSIZE byte
 537  * sector size.
 538  */
 539 #define NSPB(fs)        ((fs)->fs_nspf << (fs)->fs_fragshift)
 540 #define NSPF(fs)        ((fs)->fs_nspf)
 541
 542 /*
 543  * Number of inodes in a secondary storage block/fragment.
 544  */
 545 #define INOPB(fs)       ((fs)->fs_inopb)
 546 #define INOPF(fs)       ((fs)->fs_inopb >> (fs)->fs_fragshift)
 547
 548 /*
 549  * Number of indirects in a filesystem block.
 550  */
 551 #define NINDIR(fs)      ((fs)->fs_nindir)
 552
 553 extern int inside[], around[];
 554 extern u_char *fragtbl[];
 555
 556 #endif /* !_UFS_FFS_FS_H_ */