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