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