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