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