xref: /illumos-gate/usr/src/boot/sys/ufs/ffs/fs.h (revision 199767f8)
1*199767f8SToomas Soome /*-
2*199767f8SToomas Soome  * Copyright (c) 1982, 1986, 1993
3*199767f8SToomas Soome  *	The Regents of the University of California.  All rights reserved.
4*199767f8SToomas Soome  *
5*199767f8SToomas Soome  * Redistribution and use in source and binary forms, with or without
6*199767f8SToomas Soome  * modification, are permitted provided that the following conditions
7*199767f8SToomas Soome  * are met:
8*199767f8SToomas Soome  * 1. Redistributions of source code must retain the above copyright
9*199767f8SToomas Soome  *    notice, this list of conditions and the following disclaimer.
10*199767f8SToomas Soome  * 2. Redistributions in binary form must reproduce the above copyright
11*199767f8SToomas Soome  *    notice, this list of conditions and the following disclaimer in the
12*199767f8SToomas Soome  *    documentation and/or other materials provided with the distribution.
13*199767f8SToomas Soome  * 3. Neither the name of the University nor the names of its contributors
14*199767f8SToomas Soome  *    may be used to endorse or promote products derived from this software
15*199767f8SToomas Soome  *    without specific prior written permission.
16*199767f8SToomas Soome  *
17*199767f8SToomas Soome  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18*199767f8SToomas Soome  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19*199767f8SToomas Soome  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20*199767f8SToomas Soome  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21*199767f8SToomas Soome  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22*199767f8SToomas Soome  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23*199767f8SToomas Soome  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24*199767f8SToomas Soome  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25*199767f8SToomas Soome  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26*199767f8SToomas Soome  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27*199767f8SToomas Soome  * SUCH DAMAGE.
28*199767f8SToomas Soome  *
29*199767f8SToomas Soome  *	@(#)fs.h	8.13 (Berkeley) 3/21/95
30*199767f8SToomas Soome  * $FreeBSD$
31*199767f8SToomas Soome  */
32*199767f8SToomas Soome 
33*199767f8SToomas Soome #ifndef _UFS_FFS_FS_H_
34*199767f8SToomas Soome #define	_UFS_FFS_FS_H_
35*199767f8SToomas Soome 
36*199767f8SToomas Soome #include <sys/mount.h>
37*199767f8SToomas Soome #include <ufs/ufs/dinode.h>
38*199767f8SToomas Soome 
39*199767f8SToomas Soome /*
40*199767f8SToomas Soome  * Each disk drive contains some number of filesystems.
41*199767f8SToomas Soome  * A filesystem consists of a number of cylinder groups.
42*199767f8SToomas Soome  * Each cylinder group has inodes and data.
43*199767f8SToomas Soome  *
44*199767f8SToomas Soome  * A filesystem is described by its super-block, which in turn
45*199767f8SToomas Soome  * describes the cylinder groups.  The super-block is critical
46*199767f8SToomas Soome  * data and is replicated in each cylinder group to protect against
47*199767f8SToomas Soome  * catastrophic loss.  This is done at `newfs' time and the critical
48*199767f8SToomas Soome  * super-block data does not change, so the copies need not be
49*199767f8SToomas Soome  * referenced further unless disaster strikes.
50*199767f8SToomas Soome  *
51*199767f8SToomas Soome  * For filesystem fs, the offsets of the various blocks of interest
52*199767f8SToomas Soome  * are given in the super block as:
53*199767f8SToomas Soome  *	[fs->fs_sblkno]		Super-block
54*199767f8SToomas Soome  *	[fs->fs_cblkno]		Cylinder group block
55*199767f8SToomas Soome  *	[fs->fs_iblkno]		Inode blocks
56*199767f8SToomas Soome  *	[fs->fs_dblkno]		Data blocks
57*199767f8SToomas Soome  * The beginning of cylinder group cg in fs, is given by
58*199767f8SToomas Soome  * the ``cgbase(fs, cg)'' macro.
59*199767f8SToomas Soome  *
60*199767f8SToomas Soome  * Depending on the architecture and the media, the superblock may
61*199767f8SToomas Soome  * reside in any one of four places. For tiny media where every block
62*199767f8SToomas Soome  * counts, it is placed at the very front of the partition. Historically,
63*199767f8SToomas Soome  * UFS1 placed it 8K from the front to leave room for the disk label and
64*199767f8SToomas Soome  * a small bootstrap. For UFS2 it got moved to 64K from the front to leave
65*199767f8SToomas Soome  * room for the disk label and a bigger bootstrap, and for really piggy
66*199767f8SToomas Soome  * systems we check at 256K from the front if the first three fail. In
67*199767f8SToomas Soome  * all cases the size of the superblock will be SBLOCKSIZE. All values are
68*199767f8SToomas Soome  * given in byte-offset form, so they do not imply a sector size. The
69*199767f8SToomas Soome  * SBLOCKSEARCH specifies the order in which the locations should be searched.
70*199767f8SToomas Soome  */
71*199767f8SToomas Soome #define	SBLOCK_FLOPPY	     0
72*199767f8SToomas Soome #define	SBLOCK_UFS1	  8192
73*199767f8SToomas Soome #define	SBLOCK_UFS2	 65536
74*199767f8SToomas Soome #define	SBLOCK_PIGGY	262144
75*199767f8SToomas Soome #define	SBLOCKSIZE	  8192
76*199767f8SToomas Soome #define	SBLOCKSEARCH \
77*199767f8SToomas Soome 	{ SBLOCK_UFS2, SBLOCK_UFS1, SBLOCK_FLOPPY, SBLOCK_PIGGY, -1 }
78*199767f8SToomas Soome 
79*199767f8SToomas Soome /*
80*199767f8SToomas Soome  * Max number of fragments per block. This value is NOT tweakable.
81*199767f8SToomas Soome  */
82*199767f8SToomas Soome #define	MAXFRAG 	8
83*199767f8SToomas Soome 
84*199767f8SToomas Soome /*
85*199767f8SToomas Soome  * Addresses stored in inodes are capable of addressing fragments
86*199767f8SToomas Soome  * of `blocks'. File system blocks of at most size MAXBSIZE can
87*199767f8SToomas Soome  * be optionally broken into 2, 4, or 8 pieces, each of which is
88*199767f8SToomas Soome  * addressable; these pieces may be DEV_BSIZE, or some multiple of
89*199767f8SToomas Soome  * a DEV_BSIZE unit.
90*199767f8SToomas Soome  *
91*199767f8SToomas Soome  * Large files consist of exclusively large data blocks.  To avoid
92*199767f8SToomas Soome  * undue wasted disk space, the last data block of a small file may be
93*199767f8SToomas Soome  * allocated as only as many fragments of a large block as are
94*199767f8SToomas Soome  * necessary.  The filesystem format retains only a single pointer
95*199767f8SToomas Soome  * to such a fragment, which is a piece of a single large block that
96*199767f8SToomas Soome  * has been divided.  The size of such a fragment is determinable from
97*199767f8SToomas Soome  * information in the inode, using the ``blksize(fs, ip, lbn)'' macro.
98*199767f8SToomas Soome  *
99*199767f8SToomas Soome  * The filesystem records space availability at the fragment level;
100*199767f8SToomas Soome  * to determine block availability, aligned fragments are examined.
101*199767f8SToomas Soome  */
102*199767f8SToomas Soome 
103*199767f8SToomas Soome /*
104*199767f8SToomas Soome  * MINBSIZE is the smallest allowable block size.
105*199767f8SToomas Soome  * In order to insure that it is possible to create files of size
106*199767f8SToomas Soome  * 2^32 with only two levels of indirection, MINBSIZE is set to 4096.
107*199767f8SToomas Soome  * MINBSIZE must be big enough to hold a cylinder group block,
108*199767f8SToomas Soome  * thus changes to (struct cg) must keep its size within MINBSIZE.
109*199767f8SToomas Soome  * Note that super blocks are always of size SBLOCKSIZE,
110*199767f8SToomas Soome  * and that both SBLOCKSIZE and MAXBSIZE must be >= MINBSIZE.
111*199767f8SToomas Soome  */
112*199767f8SToomas Soome #define	MINBSIZE	4096
113*199767f8SToomas Soome 
114*199767f8SToomas Soome /*
115*199767f8SToomas Soome  * The path name on which the filesystem is mounted is maintained
116*199767f8SToomas Soome  * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in
117*199767f8SToomas Soome  * the super block for this name.
118*199767f8SToomas Soome  */
119*199767f8SToomas Soome #define	MAXMNTLEN	468
120*199767f8SToomas Soome 
121*199767f8SToomas Soome /*
122*199767f8SToomas Soome  * The volume name for this filesystem is maintained in fs_volname.
123*199767f8SToomas Soome  * MAXVOLLEN defines the length of the buffer allocated.
124*199767f8SToomas Soome  */
125*199767f8SToomas Soome #define	MAXVOLLEN	32
126*199767f8SToomas Soome 
127*199767f8SToomas Soome /*
128*199767f8SToomas Soome  * There is a 128-byte region in the superblock reserved for in-core
129*199767f8SToomas Soome  * pointers to summary information. Originally this included an array
130*199767f8SToomas Soome  * of pointers to blocks of struct csum; now there are just a few
131*199767f8SToomas Soome  * pointers and the remaining space is padded with fs_ocsp[].
132*199767f8SToomas Soome  *
133*199767f8SToomas Soome  * NOCSPTRS determines the size of this padding. One pointer (fs_csp)
134*199767f8SToomas Soome  * is taken away to point to a contiguous array of struct csum for
135*199767f8SToomas Soome  * all cylinder groups; a second (fs_maxcluster) points to an array
136*199767f8SToomas Soome  * of cluster sizes that is computed as cylinder groups are inspected,
137*199767f8SToomas Soome  * and the third points to an array that tracks the creation of new
138*199767f8SToomas Soome  * directories. A fourth pointer, fs_active, is used when creating
139*199767f8SToomas Soome  * snapshots; it points to a bitmap of cylinder groups for which the
140*199767f8SToomas Soome  * free-block bitmap has changed since the snapshot operation began.
141*199767f8SToomas Soome  */
142*199767f8SToomas Soome #define	NOCSPTRS	((128 / sizeof(void *)) - 4)
143*199767f8SToomas Soome 
144*199767f8SToomas Soome /*
145*199767f8SToomas Soome  * A summary of contiguous blocks of various sizes is maintained
146*199767f8SToomas Soome  * in each cylinder group. Normally this is set by the initial
147*199767f8SToomas Soome  * value of fs_maxcontig. To conserve space, a maximum summary size
148*199767f8SToomas Soome  * is set by FS_MAXCONTIG.
149*199767f8SToomas Soome  */
150*199767f8SToomas Soome #define	FS_MAXCONTIG	16
151*199767f8SToomas Soome 
152*199767f8SToomas Soome /*
153*199767f8SToomas Soome  * MINFREE gives the minimum acceptable percentage of filesystem
154*199767f8SToomas Soome  * blocks which may be free. If the freelist drops below this level
155*199767f8SToomas Soome  * only the superuser may continue to allocate blocks. This may
156*199767f8SToomas Soome  * be set to 0 if no reserve of free blocks is deemed necessary,
157*199767f8SToomas Soome  * however throughput drops by fifty percent if the filesystem
158*199767f8SToomas Soome  * is run at between 95% and 100% full; thus the minimum default
159*199767f8SToomas Soome  * value of fs_minfree is 5%. However, to get good clustering
160*199767f8SToomas Soome  * performance, 10% is a better choice. hence we use 10% as our
161*199767f8SToomas Soome  * default value. With 10% free space, fragmentation is not a
162*199767f8SToomas Soome  * problem, so we choose to optimize for time.
163*199767f8SToomas Soome  */
164*199767f8SToomas Soome #define	MINFREE		8
165*199767f8SToomas Soome #define	DEFAULTOPT	FS_OPTTIME
166*199767f8SToomas Soome 
167*199767f8SToomas Soome /*
168*199767f8SToomas Soome  * Grigoriy Orlov <gluk@ptci.ru> has done some extensive work to fine
169*199767f8SToomas Soome  * tune the layout preferences for directories within a filesystem.
170*199767f8SToomas Soome  * His algorithm can be tuned by adjusting the following parameters
171*199767f8SToomas Soome  * which tell the system the average file size and the average number
172*199767f8SToomas Soome  * of files per directory. These defaults are well selected for typical
173*199767f8SToomas Soome  * filesystems, but may need to be tuned for odd cases like filesystems
174*199767f8SToomas Soome  * being used for squid caches or news spools.
175*199767f8SToomas Soome  */
176*199767f8SToomas Soome #define	AVFILESIZ	16384	/* expected average file size */
177*199767f8SToomas Soome #define	AFPDIR		64	/* expected number of files per directory */
178*199767f8SToomas Soome 
179*199767f8SToomas Soome /*
180*199767f8SToomas Soome  * The maximum number of snapshot nodes that can be associated
181*199767f8SToomas Soome  * with each filesystem. This limit affects only the number of
182*199767f8SToomas Soome  * snapshot files that can be recorded within the superblock so
183*199767f8SToomas Soome  * that they can be found when the filesystem is mounted. However,
184*199767f8SToomas Soome  * maintaining too many will slow the filesystem performance, so
185*199767f8SToomas Soome  * having this limit is a good idea.
186*199767f8SToomas Soome  */
187*199767f8SToomas Soome #define	FSMAXSNAP 20
188*199767f8SToomas Soome 
189*199767f8SToomas Soome /*
190*199767f8SToomas Soome  * Used to identify special blocks in snapshots:
191*199767f8SToomas Soome  *
192*199767f8SToomas Soome  * BLK_NOCOPY - A block that was unallocated at the time the snapshot
193*199767f8SToomas Soome  *	was taken, hence does not need to be copied when written.
194*199767f8SToomas Soome  * BLK_SNAP - A block held by another snapshot that is not needed by this
195*199767f8SToomas Soome  *	snapshot. When the other snapshot is freed, the BLK_SNAP entries
196*199767f8SToomas Soome  *	are converted to BLK_NOCOPY. These are needed to allow fsck to
197*199767f8SToomas Soome  *	identify blocks that are in use by other snapshots (which are
198*199767f8SToomas Soome  *	expunged from this snapshot).
199*199767f8SToomas Soome  */
200*199767f8SToomas Soome #define	BLK_NOCOPY ((ufs2_daddr_t)(1))
201*199767f8SToomas Soome #define	BLK_SNAP ((ufs2_daddr_t)(2))
202*199767f8SToomas Soome 
203*199767f8SToomas Soome /*
204*199767f8SToomas Soome  * Sysctl values for the fast filesystem.
205*199767f8SToomas Soome  */
206*199767f8SToomas Soome #define	FFS_ADJ_REFCNT		 1	/* adjust inode reference count */
207*199767f8SToomas Soome #define	FFS_ADJ_BLKCNT		 2	/* adjust inode used block count */
208*199767f8SToomas Soome #define	FFS_BLK_FREE		 3	/* free range of blocks in map */
209*199767f8SToomas Soome #define	FFS_DIR_FREE		 4	/* free specified dir inodes in map */
210*199767f8SToomas Soome #define	FFS_FILE_FREE		 5	/* free specified file inodes in map */
211*199767f8SToomas Soome #define	FFS_SET_FLAGS		 6	/* set filesystem flags */
212*199767f8SToomas Soome #define	FFS_ADJ_NDIR		 7	/* adjust number of directories */
213*199767f8SToomas Soome #define	FFS_ADJ_NBFREE		 8	/* adjust number of free blocks */
214*199767f8SToomas Soome #define	FFS_ADJ_NIFREE		 9	/* adjust number of free inodes */
215*199767f8SToomas Soome #define	FFS_ADJ_NFFREE		10 	/* adjust number of free frags */
216*199767f8SToomas Soome #define	FFS_ADJ_NUMCLUSTERS	11	/* adjust number of free clusters */
217*199767f8SToomas Soome #define	FFS_SET_CWD		12	/* set current directory */
218*199767f8SToomas Soome #define	FFS_SET_DOTDOT		13	/* set inode number for ".." */
219*199767f8SToomas Soome #define	FFS_UNLINK		14	/* remove a name in the filesystem */
220*199767f8SToomas Soome #define	FFS_SET_INODE		15	/* update an on-disk inode */
221*199767f8SToomas Soome #define	FFS_SET_BUFOUTPUT	16	/* set buffered writing on descriptor */
222*199767f8SToomas Soome #define	FFS_MAXID		16	/* number of valid ffs ids */
223*199767f8SToomas Soome 
224*199767f8SToomas Soome /*
225*199767f8SToomas Soome  * Command structure passed in to the filesystem to adjust filesystem values.
226*199767f8SToomas Soome  */
227*199767f8SToomas Soome #define	FFS_CMD_VERSION		0x19790518	/* version ID */
228*199767f8SToomas Soome struct fsck_cmd {
229*199767f8SToomas Soome 	int32_t	version;	/* version of command structure */
230*199767f8SToomas Soome 	int32_t	handle;		/* reference to filesystem to be changed */
231*199767f8SToomas Soome 	int64_t	value;		/* inode or block number to be affected */
232*199767f8SToomas Soome 	int64_t	size;		/* amount or range to be adjusted */
233*199767f8SToomas Soome 	int64_t	spare;		/* reserved for future use */
234*199767f8SToomas Soome };
235*199767f8SToomas Soome 
236*199767f8SToomas Soome /*
237*199767f8SToomas Soome  * Per cylinder group information; summarized in blocks allocated
238*199767f8SToomas Soome  * from first cylinder group data blocks.  These blocks have to be
239*199767f8SToomas Soome  * read in from fs_csaddr (size fs_cssize) in addition to the
240*199767f8SToomas Soome  * super block.
241*199767f8SToomas Soome  */
242*199767f8SToomas Soome struct csum {
243*199767f8SToomas Soome 	int32_t	cs_ndir;		/* number of directories */
244*199767f8SToomas Soome 	int32_t	cs_nbfree;		/* number of free blocks */
245*199767f8SToomas Soome 	int32_t	cs_nifree;		/* number of free inodes */
246*199767f8SToomas Soome 	int32_t	cs_nffree;		/* number of free frags */
247*199767f8SToomas Soome };
248*199767f8SToomas Soome struct csum_total {
249*199767f8SToomas Soome 	int64_t	cs_ndir;		/* number of directories */
250*199767f8SToomas Soome 	int64_t	cs_nbfree;		/* number of free blocks */
251*199767f8SToomas Soome 	int64_t	cs_nifree;		/* number of free inodes */
252*199767f8SToomas Soome 	int64_t	cs_nffree;		/* number of free frags */
253*199767f8SToomas Soome 	int64_t	cs_numclusters;		/* number of free clusters */
254*199767f8SToomas Soome 	int64_t	cs_spare[3];		/* future expansion */
255*199767f8SToomas Soome };
256*199767f8SToomas Soome 
257*199767f8SToomas Soome /*
258*199767f8SToomas Soome  * Super block for an FFS filesystem.
259*199767f8SToomas Soome  */
260*199767f8SToomas Soome struct fs {
261*199767f8SToomas Soome 	int32_t	 fs_firstfield;		/* historic filesystem linked list, */
262*199767f8SToomas Soome 	int32_t	 fs_unused_1;		/*     used for incore super blocks */
263*199767f8SToomas Soome 	int32_t	 fs_sblkno;		/* offset of super-block in filesys */
264*199767f8SToomas Soome 	int32_t	 fs_cblkno;		/* offset of cyl-block in filesys */
265*199767f8SToomas Soome 	int32_t	 fs_iblkno;		/* offset of inode-blocks in filesys */
266*199767f8SToomas Soome 	int32_t	 fs_dblkno;		/* offset of first data after cg */
267*199767f8SToomas Soome 	int32_t	 fs_old_cgoffset;	/* cylinder group offset in cylinder */
268*199767f8SToomas Soome 	int32_t	 fs_old_cgmask;		/* used to calc mod fs_ntrak */
269*199767f8SToomas Soome 	int32_t  fs_old_time;		/* last time written */
270*199767f8SToomas Soome 	int32_t	 fs_old_size;		/* number of blocks in fs */
271*199767f8SToomas Soome 	int32_t	 fs_old_dsize;		/* number of data blocks in fs */
272*199767f8SToomas Soome 	u_int32_t fs_ncg;		/* number of cylinder groups */
273*199767f8SToomas Soome 	int32_t	 fs_bsize;		/* size of basic blocks in fs */
274*199767f8SToomas Soome 	int32_t	 fs_fsize;		/* size of frag blocks in fs */
275*199767f8SToomas Soome 	int32_t	 fs_frag;		/* number of frags in a block in fs */
276*199767f8SToomas Soome /* these are configuration parameters */
277*199767f8SToomas Soome 	int32_t	 fs_minfree;		/* minimum percentage of free blocks */
278*199767f8SToomas Soome 	int32_t	 fs_old_rotdelay;	/* num of ms for optimal next block */
279*199767f8SToomas Soome 	int32_t	 fs_old_rps;		/* disk revolutions per second */
280*199767f8SToomas Soome /* these fields can be computed from the others */
281*199767f8SToomas Soome 	int32_t	 fs_bmask;		/* ``blkoff'' calc of blk offsets */
282*199767f8SToomas Soome 	int32_t	 fs_fmask;		/* ``fragoff'' calc of frag offsets */
283*199767f8SToomas Soome 	int32_t	 fs_bshift;		/* ``lblkno'' calc of logical blkno */
284*199767f8SToomas Soome 	int32_t	 fs_fshift;		/* ``numfrags'' calc number of frags */
285*199767f8SToomas Soome /* these are configuration parameters */
286*199767f8SToomas Soome 	int32_t	 fs_maxcontig;		/* max number of contiguous blks */
287*199767f8SToomas Soome 	int32_t	 fs_maxbpg;		/* max number of blks per cyl group */
288*199767f8SToomas Soome /* these fields can be computed from the others */
289*199767f8SToomas Soome 	int32_t	 fs_fragshift;		/* block to frag shift */
290*199767f8SToomas Soome 	int32_t	 fs_fsbtodb;		/* fsbtodb and dbtofsb shift constant */
291*199767f8SToomas Soome 	int32_t	 fs_sbsize;		/* actual size of super block */
292*199767f8SToomas Soome 	int32_t	 fs_spare1[2];		/* old fs_csmask */
293*199767f8SToomas Soome 					/* old fs_csshift */
294*199767f8SToomas Soome 	int32_t	 fs_nindir;		/* value of NINDIR */
295*199767f8SToomas Soome 	u_int32_t fs_inopb;		/* value of INOPB */
296*199767f8SToomas Soome 	int32_t	 fs_old_nspf;		/* value of NSPF */
297*199767f8SToomas Soome /* yet another configuration parameter */
298*199767f8SToomas Soome 	int32_t	 fs_optim;		/* optimization preference, see below */
299*199767f8SToomas Soome 	int32_t	 fs_old_npsect;		/* # sectors/track including spares */
300*199767f8SToomas Soome 	int32_t	 fs_old_interleave;	/* hardware sector interleave */
301*199767f8SToomas Soome 	int32_t	 fs_old_trackskew;	/* sector 0 skew, per track */
302*199767f8SToomas Soome 	int32_t	 fs_id[2];		/* unique filesystem id */
303*199767f8SToomas Soome /* sizes determined by number of cylinder groups and their sizes */
304*199767f8SToomas Soome 	int32_t	 fs_old_csaddr;		/* blk addr of cyl grp summary area */
305*199767f8SToomas Soome 	int32_t	 fs_cssize;		/* size of cyl grp summary area */
306*199767f8SToomas Soome 	int32_t	 fs_cgsize;		/* cylinder group size */
307*199767f8SToomas Soome 	int32_t	 fs_spare2;		/* old fs_ntrak */
308*199767f8SToomas Soome 	int32_t	 fs_old_nsect;		/* sectors per track */
309*199767f8SToomas Soome 	int32_t  fs_old_spc;		/* sectors per cylinder */
310*199767f8SToomas Soome 	int32_t	 fs_old_ncyl;		/* cylinders in filesystem */
311*199767f8SToomas Soome 	int32_t	 fs_old_cpg;		/* cylinders per group */
312*199767f8SToomas Soome 	u_int32_t fs_ipg;		/* inodes per group */
313*199767f8SToomas Soome 	int32_t	 fs_fpg;		/* blocks per group * fs_frag */
314*199767f8SToomas Soome /* this data must be re-computed after crashes */
315*199767f8SToomas Soome 	struct	csum fs_old_cstotal;	/* cylinder summary information */
316*199767f8SToomas Soome /* these fields are cleared at mount time */
317*199767f8SToomas Soome 	int8_t   fs_fmod;		/* super block modified flag */
318*199767f8SToomas Soome 	int8_t   fs_clean;		/* filesystem is clean flag */
319*199767f8SToomas Soome 	int8_t 	 fs_ronly;		/* mounted read-only flag */
320*199767f8SToomas Soome 	int8_t   fs_old_flags;		/* old FS_ flags */
321*199767f8SToomas Soome 	u_char	 fs_fsmnt[MAXMNTLEN];	/* name mounted on */
322*199767f8SToomas Soome 	u_char	 fs_volname[MAXVOLLEN];	/* volume name */
323*199767f8SToomas Soome 	u_int64_t fs_swuid;		/* system-wide uid */
324*199767f8SToomas Soome 	int32_t  fs_pad;		/* due to alignment of fs_swuid */
325*199767f8SToomas Soome /* these fields retain the current block allocation info */
326*199767f8SToomas Soome 	int32_t	 fs_cgrotor;		/* last cg searched */
327*199767f8SToomas Soome 	void 	*fs_ocsp[NOCSPTRS];	/* padding; was list of fs_cs buffers */
328*199767f8SToomas Soome 	u_int8_t *fs_contigdirs;	/* (u) # of contig. allocated dirs */
329*199767f8SToomas Soome 	struct	csum *fs_csp;		/* (u) cg summary info buffer */
330*199767f8SToomas Soome 	int32_t	*fs_maxcluster;		/* (u) max cluster in each cyl group */
331*199767f8SToomas Soome 	u_int	*fs_active;		/* (u) used by snapshots to track fs */
332*199767f8SToomas Soome 	int32_t	 fs_old_cpc;		/* cyl per cycle in postbl */
333*199767f8SToomas Soome 	int32_t	 fs_maxbsize;		/* maximum blocking factor permitted */
334*199767f8SToomas Soome 	int64_t	 fs_unrefs;		/* number of unreferenced inodes */
335*199767f8SToomas Soome 	int64_t  fs_providersize;	/* size of underlying GEOM provider */
336*199767f8SToomas Soome 	int64_t	 fs_metaspace;		/* size of area reserved for metadata */
337*199767f8SToomas Soome 	int64_t	 fs_sparecon64[14];	/* old rotation block list head */
338*199767f8SToomas Soome 	int64_t	 fs_sblockloc;		/* byte offset of standard superblock */
339*199767f8SToomas Soome 	struct	csum_total fs_cstotal;	/* (u) cylinder summary information */
340*199767f8SToomas Soome 	ufs_time_t fs_time;		/* last time written */
341*199767f8SToomas Soome 	int64_t	 fs_size;		/* number of blocks in fs */
342*199767f8SToomas Soome 	int64_t	 fs_dsize;		/* number of data blocks in fs */
343*199767f8SToomas Soome 	ufs2_daddr_t fs_csaddr;		/* blk addr of cyl grp summary area */
344*199767f8SToomas Soome 	int64_t	 fs_pendingblocks;	/* (u) blocks being freed */
345*199767f8SToomas Soome 	u_int32_t fs_pendinginodes;	/* (u) inodes being freed */
346*199767f8SToomas Soome 	uint32_t fs_snapinum[FSMAXSNAP];/* list of snapshot inode numbers */
347*199767f8SToomas Soome 	u_int32_t fs_avgfilesize;	/* expected average file size */
348*199767f8SToomas Soome 	u_int32_t fs_avgfpdir;		/* expected # of files per directory */
349*199767f8SToomas Soome 	int32_t	 fs_save_cgsize;	/* save real cg size to use fs_bsize */
350*199767f8SToomas Soome 	ufs_time_t fs_mtime;		/* Last mount or fsck time. */
351*199767f8SToomas Soome 	int32_t  fs_sujfree;		/* SUJ free list */
352*199767f8SToomas Soome 	int32_t	 fs_sparecon32[23];	/* reserved for future constants */
353*199767f8SToomas Soome 	int32_t  fs_flags;		/* see FS_ flags below */
354*199767f8SToomas Soome 	int32_t	 fs_contigsumsize;	/* size of cluster summary array */
355*199767f8SToomas Soome 	int32_t	 fs_maxsymlinklen;	/* max length of an internal symlink */
356*199767f8SToomas Soome 	int32_t	 fs_old_inodefmt;	/* format of on-disk inodes */
357*199767f8SToomas Soome 	u_int64_t fs_maxfilesize;	/* maximum representable file size */
358*199767f8SToomas Soome 	int64_t	 fs_qbmask;		/* ~fs_bmask for use with 64-bit size */
359*199767f8SToomas Soome 	int64_t	 fs_qfmask;		/* ~fs_fmask for use with 64-bit size */
360*199767f8SToomas Soome 	int32_t	 fs_state;		/* validate fs_clean field */
361*199767f8SToomas Soome 	int32_t	 fs_old_postblformat;	/* format of positional layout tables */
362*199767f8SToomas Soome 	int32_t	 fs_old_nrpos;		/* number of rotational positions */
363*199767f8SToomas Soome 	int32_t	 fs_spare5[2];		/* old fs_postbloff */
364*199767f8SToomas Soome 					/* old fs_rotbloff */
365*199767f8SToomas Soome 	int32_t	 fs_magic;		/* magic number */
366*199767f8SToomas Soome };
367*199767f8SToomas Soome 
368*199767f8SToomas Soome /* Sanity checking. */
369*199767f8SToomas Soome #ifdef CTASSERT
370*199767f8SToomas Soome CTASSERT(sizeof(struct fs) == 1376);
371*199767f8SToomas Soome #endif
372*199767f8SToomas Soome 
373*199767f8SToomas Soome /*
374*199767f8SToomas Soome  * Filesystem identification
375*199767f8SToomas Soome  */
376*199767f8SToomas Soome #define	FS_UFS1_MAGIC	0x011954	/* UFS1 fast filesystem magic number */
377*199767f8SToomas Soome #define	FS_UFS2_MAGIC	0x19540119	/* UFS2 fast filesystem magic number */
378*199767f8SToomas Soome #define	FS_BAD_MAGIC	0x19960408	/* UFS incomplete newfs magic number */
379*199767f8SToomas Soome #define	FS_OKAY		0x7c269d38	/* superblock checksum */
380*199767f8SToomas Soome #define	FS_42INODEFMT	-1		/* 4.2BSD inode format */
381*199767f8SToomas Soome #define	FS_44INODEFMT	2		/* 4.4BSD inode format */
382*199767f8SToomas Soome 
383*199767f8SToomas Soome /*
384*199767f8SToomas Soome  * Preference for optimization.
385*199767f8SToomas Soome  */
386*199767f8SToomas Soome #define	FS_OPTTIME	0	/* minimize allocation time */
387*199767f8SToomas Soome #define	FS_OPTSPACE	1	/* minimize disk fragmentation */
388*199767f8SToomas Soome 
389*199767f8SToomas Soome /*
390*199767f8SToomas Soome  * Filesystem flags.
391*199767f8SToomas Soome  *
392*199767f8SToomas Soome  * The FS_UNCLEAN flag is set by the kernel when the filesystem was
393*199767f8SToomas Soome  * mounted with fs_clean set to zero. The FS_DOSOFTDEP flag indicates
394*199767f8SToomas Soome  * that the filesystem should be managed by the soft updates code.
395*199767f8SToomas Soome  * Note that the FS_NEEDSFSCK flag is set and cleared only by the
396*199767f8SToomas Soome  * fsck utility. It is set when background fsck finds an unexpected
397*199767f8SToomas Soome  * inconsistency which requires a traditional foreground fsck to be
398*199767f8SToomas Soome  * run. Such inconsistencies should only be found after an uncorrectable
399*199767f8SToomas Soome  * disk error. A foreground fsck will clear the FS_NEEDSFSCK flag when
400*199767f8SToomas Soome  * it has successfully cleaned up the filesystem. The kernel uses this
401*199767f8SToomas Soome  * flag to enforce that inconsistent filesystems be mounted read-only.
402*199767f8SToomas Soome  * The FS_INDEXDIRS flag when set indicates that the kernel maintains
403*199767f8SToomas Soome  * on-disk auxiliary indexes (such as B-trees) for speeding directory
404*199767f8SToomas Soome  * accesses. Kernels that do not support auxiliary indicies clear the
405*199767f8SToomas Soome  * flag to indicate that the indicies need to be rebuilt (by fsck) before
406*199767f8SToomas Soome  * they can be used.
407*199767f8SToomas Soome  *
408*199767f8SToomas Soome  * FS_ACLS indicates that POSIX.1e ACLs are administratively enabled
409*199767f8SToomas Soome  * for the file system, so they should be loaded from extended attributes,
410*199767f8SToomas Soome  * observed for access control purposes, and be administered by object
411*199767f8SToomas Soome  * owners.  FS_NFS4ACLS indicates that NFSv4 ACLs are administratively
412*199767f8SToomas Soome  * enabled.  This flag is mutually exclusive with FS_ACLS.  FS_MULTILABEL
413*199767f8SToomas Soome  * indicates that the TrustedBSD MAC Framework should attempt to back MAC
414*199767f8SToomas Soome  * labels into extended attributes on the file system rather than maintain
415*199767f8SToomas Soome  * a single mount label for all objects.
416*199767f8SToomas Soome  */
417*199767f8SToomas Soome #define	FS_UNCLEAN	0x0001	/* filesystem not clean at mount */
418*199767f8SToomas Soome #define	FS_DOSOFTDEP	0x0002	/* filesystem using soft dependencies */
419*199767f8SToomas Soome #define	FS_NEEDSFSCK	0x0004	/* filesystem needs sync fsck before mount */
420*199767f8SToomas Soome #define	FS_SUJ       	0x0008	/* Filesystem using softupdate journal */
421*199767f8SToomas Soome #define	FS_ACLS		0x0010	/* file system has POSIX.1e ACLs enabled */
422*199767f8SToomas Soome #define	FS_MULTILABEL	0x0020	/* file system is MAC multi-label */
423*199767f8SToomas Soome #define	FS_GJOURNAL	0x0040	/* gjournaled file system */
424*199767f8SToomas Soome #define	FS_FLAGS_UPDATED 0x0080	/* flags have been moved to new location */
425*199767f8SToomas Soome #define	FS_NFS4ACLS	0x0100	/* file system has NFSv4 ACLs enabled */
426*199767f8SToomas Soome #define	FS_INDEXDIRS	0x0200	/* kernel supports indexed directories */
427*199767f8SToomas Soome #define	FS_TRIM		0x0400	/* issue BIO_DELETE for deleted blocks */
428*199767f8SToomas Soome 
429*199767f8SToomas Soome /*
430*199767f8SToomas Soome  * Macros to access bits in the fs_active array.
431*199767f8SToomas Soome  */
432*199767f8SToomas Soome #define	ACTIVECGNUM(fs, cg)	((fs)->fs_active[(cg) / (NBBY * sizeof(int))])
433*199767f8SToomas Soome #define	ACTIVECGOFF(cg)		(1 << ((cg) % (NBBY * sizeof(int))))
434*199767f8SToomas Soome #define	ACTIVESET(fs, cg)	do {					\
435*199767f8SToomas Soome 	if ((fs)->fs_active)						\
436*199767f8SToomas Soome 		ACTIVECGNUM((fs), (cg)) |= ACTIVECGOFF((cg));		\
437*199767f8SToomas Soome } while (0)
438*199767f8SToomas Soome #define	ACTIVECLEAR(fs, cg)	do {					\
439*199767f8SToomas Soome 	if ((fs)->fs_active)						\
440*199767f8SToomas Soome 		ACTIVECGNUM((fs), (cg)) &= ~ACTIVECGOFF((cg));		\
441*199767f8SToomas Soome } while (0)
442*199767f8SToomas Soome 
443*199767f8SToomas Soome /*
444*199767f8SToomas Soome  * The size of a cylinder group is calculated by CGSIZE. The maximum size
445*199767f8SToomas Soome  * is limited by the fact that cylinder groups are at most one block.
446*199767f8SToomas Soome  * Its size is derived from the size of the maps maintained in the
447*199767f8SToomas Soome  * cylinder group and the (struct cg) size.
448*199767f8SToomas Soome  */
449*199767f8SToomas Soome #define	CGSIZE(fs) \
450*199767f8SToomas Soome     /* base cg */	(sizeof(struct cg) + sizeof(int32_t) + \
451*199767f8SToomas Soome     /* old btotoff */	(fs)->fs_old_cpg * sizeof(int32_t) + \
452*199767f8SToomas Soome     /* old boff */	(fs)->fs_old_cpg * sizeof(u_int16_t) + \
453*199767f8SToomas Soome     /* inode map */	howmany((fs)->fs_ipg, NBBY) + \
454*199767f8SToomas Soome     /* block map */	howmany((fs)->fs_fpg, NBBY) +\
455*199767f8SToomas Soome     /* if present */	((fs)->fs_contigsumsize <= 0 ? 0 : \
456*199767f8SToomas Soome     /* cluster sum */	(fs)->fs_contigsumsize * sizeof(int32_t) + \
457*199767f8SToomas Soome     /* cluster map */	howmany(fragstoblks(fs, (fs)->fs_fpg), NBBY)))
458*199767f8SToomas Soome 
459*199767f8SToomas Soome /*
460*199767f8SToomas Soome  * The minimal number of cylinder groups that should be created.
461*199767f8SToomas Soome  */
462*199767f8SToomas Soome #define	MINCYLGRPS	4
463*199767f8SToomas Soome 
464*199767f8SToomas Soome /*
465*199767f8SToomas Soome  * Convert cylinder group to base address of its global summary info.
466*199767f8SToomas Soome  */
467*199767f8SToomas Soome #define	fs_cs(fs, indx) fs_csp[indx]
468*199767f8SToomas Soome 
469*199767f8SToomas Soome /*
470*199767f8SToomas Soome  * Cylinder group block for a filesystem.
471*199767f8SToomas Soome  */
472*199767f8SToomas Soome #define	CG_MAGIC	0x090255
473*199767f8SToomas Soome struct cg {
474*199767f8SToomas Soome 	int32_t	 cg_firstfield;		/* historic cyl groups linked list */
475*199767f8SToomas Soome 	int32_t	 cg_magic;		/* magic number */
476*199767f8SToomas Soome 	int32_t  cg_old_time;		/* time last written */
477*199767f8SToomas Soome 	u_int32_t cg_cgx;		/* we are the cgx'th cylinder group */
478*199767f8SToomas Soome 	int16_t	 cg_old_ncyl;		/* number of cyl's this cg */
479*199767f8SToomas Soome 	int16_t  cg_old_niblk;		/* number of inode blocks this cg */
480*199767f8SToomas Soome 	u_int32_t cg_ndblk;		/* number of data blocks this cg */
481*199767f8SToomas Soome 	struct	 csum cg_cs;		/* cylinder summary information */
482*199767f8SToomas Soome 	u_int32_t cg_rotor;		/* position of last used block */
483*199767f8SToomas Soome 	u_int32_t cg_frotor;		/* position of last used frag */
484*199767f8SToomas Soome 	u_int32_t cg_irotor;		/* position of last used inode */
485*199767f8SToomas Soome 	u_int32_t cg_frsum[MAXFRAG];	/* counts of available frags */
486*199767f8SToomas Soome 	int32_t	 cg_old_btotoff;	/* (int32) block totals per cylinder */
487*199767f8SToomas Soome 	int32_t	 cg_old_boff;		/* (u_int16) free block positions */
488*199767f8SToomas Soome 	u_int32_t cg_iusedoff;		/* (u_int8) used inode map */
489*199767f8SToomas Soome 	u_int32_t cg_freeoff;		/* (u_int8) free block map */
490*199767f8SToomas Soome 	u_int32_t cg_nextfreeoff;	/* (u_int8) next available space */
491*199767f8SToomas Soome 	u_int32_t cg_clustersumoff;	/* (u_int32) counts of avail clusters */
492*199767f8SToomas Soome 	u_int32_t cg_clusteroff;		/* (u_int8) free cluster map */
493*199767f8SToomas Soome 	u_int32_t cg_nclusterblks;	/* number of clusters this cg */
494*199767f8SToomas Soome 	u_int32_t cg_niblk;		/* number of inode blocks this cg */
495*199767f8SToomas Soome 	u_int32_t cg_initediblk;		/* last initialized inode */
496*199767f8SToomas Soome 	u_int32_t cg_unrefs;		/* number of unreferenced inodes */
497*199767f8SToomas Soome 	int32_t	 cg_sparecon32[2];	/* reserved for future use */
498*199767f8SToomas Soome 	ufs_time_t cg_time;		/* time last written */
499*199767f8SToomas Soome 	int64_t	 cg_sparecon64[3];	/* reserved for future use */
500*199767f8SToomas Soome 	u_int8_t cg_space[1];		/* space for cylinder group maps */
501*199767f8SToomas Soome /* actually longer */
502*199767f8SToomas Soome };
503*199767f8SToomas Soome 
504*199767f8SToomas Soome /*
505*199767f8SToomas Soome  * Macros for access to cylinder group array structures
506*199767f8SToomas Soome  */
507*199767f8SToomas Soome #define	cg_chkmagic(cgp) ((cgp)->cg_magic == CG_MAGIC)
508*199767f8SToomas Soome #define	cg_inosused(cgp) \
509*199767f8SToomas Soome     ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_iusedoff))
510*199767f8SToomas Soome #define	cg_blksfree(cgp) \
511*199767f8SToomas Soome     ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_freeoff))
512*199767f8SToomas Soome #define	cg_clustersfree(cgp) \
513*199767f8SToomas Soome     ((u_int8_t *)((u_int8_t *)(cgp) + (cgp)->cg_clusteroff))
514*199767f8SToomas Soome #define	cg_clustersum(cgp) \
515*199767f8SToomas Soome     ((int32_t *)((uintptr_t)(cgp) + (cgp)->cg_clustersumoff))
516*199767f8SToomas Soome 
517*199767f8SToomas Soome /*
518*199767f8SToomas Soome  * Turn filesystem block numbers into disk block addresses.
519*199767f8SToomas Soome  * This maps filesystem blocks to device size blocks.
520*199767f8SToomas Soome  */
521*199767f8SToomas Soome #define	fsbtodb(fs, b)	((daddr_t)(b) << (fs)->fs_fsbtodb)
522*199767f8SToomas Soome #define	dbtofsb(fs, b)	((b) >> (fs)->fs_fsbtodb)
523*199767f8SToomas Soome 
524*199767f8SToomas Soome /*
525*199767f8SToomas Soome  * Cylinder group macros to locate things in cylinder groups.
526*199767f8SToomas Soome  * They calc filesystem addresses of cylinder group data structures.
527*199767f8SToomas Soome  */
528*199767f8SToomas Soome #define	cgbase(fs, c)	(((ufs2_daddr_t)(fs)->fs_fpg) * (c))
529*199767f8SToomas Soome #define	cgdata(fs, c)	(cgdmin(fs, c) + (fs)->fs_metaspace)	/* data zone */
530*199767f8SToomas Soome #define	cgmeta(fs, c)	(cgdmin(fs, c))				/* meta data */
531*199767f8SToomas Soome #define	cgdmin(fs, c)	(cgstart(fs, c) + (fs)->fs_dblkno)	/* 1st data */
532*199767f8SToomas Soome #define	cgimin(fs, c)	(cgstart(fs, c) + (fs)->fs_iblkno)	/* inode blk */
533*199767f8SToomas Soome #define	cgsblock(fs, c)	(cgstart(fs, c) + (fs)->fs_sblkno)	/* super blk */
534*199767f8SToomas Soome #define	cgtod(fs, c)	(cgstart(fs, c) + (fs)->fs_cblkno)	/* cg block */
535*199767f8SToomas Soome #define	cgstart(fs, c)							\
536*199767f8SToomas Soome        ((fs)->fs_magic == FS_UFS2_MAGIC ? cgbase(fs, c) :		\
537*199767f8SToomas Soome        (cgbase(fs, c) + (fs)->fs_old_cgoffset * ((c) & ~((fs)->fs_old_cgmask))))
538*199767f8SToomas Soome 
539*199767f8SToomas Soome /*
540*199767f8SToomas Soome  * Macros for handling inode numbers:
541*199767f8SToomas Soome  *     inode number to filesystem block offset.
542*199767f8SToomas Soome  *     inode number to cylinder group number.
543*199767f8SToomas Soome  *     inode number to filesystem block address.
544*199767f8SToomas Soome  */
545*199767f8SToomas Soome #define	ino_to_cg(fs, x)	(((ino_t)(x)) / (fs)->fs_ipg)
546*199767f8SToomas Soome #define	ino_to_fsba(fs, x)						\
547*199767f8SToomas Soome 	((ufs2_daddr_t)(cgimin(fs, ino_to_cg(fs, (ino_t)(x))) +		\
548*199767f8SToomas Soome 	    (blkstofrags((fs), ((((ino_t)(x)) % (fs)->fs_ipg) / INOPB(fs))))))
549*199767f8SToomas Soome #define	ino_to_fsbo(fs, x)	(((ino_t)(x)) % INOPB(fs))
550*199767f8SToomas Soome 
551*199767f8SToomas Soome /*
552*199767f8SToomas Soome  * Give cylinder group number for a filesystem block.
553*199767f8SToomas Soome  * Give cylinder group block number for a filesystem block.
554*199767f8SToomas Soome  */
555*199767f8SToomas Soome #define	dtog(fs, d)	((d) / (fs)->fs_fpg)
556*199767f8SToomas Soome #define	dtogd(fs, d)	((d) % (fs)->fs_fpg)
557*199767f8SToomas Soome 
558*199767f8SToomas Soome /*
559*199767f8SToomas Soome  * Extract the bits for a block from a map.
560*199767f8SToomas Soome  * Compute the cylinder and rotational position of a cyl block addr.
561*199767f8SToomas Soome  */
562*199767f8SToomas Soome #define	blkmap(fs, map, loc) \
563*199767f8SToomas Soome     (((map)[(loc) / NBBY] >> ((loc) % NBBY)) & (0xff >> (NBBY - (fs)->fs_frag)))
564*199767f8SToomas Soome 
565*199767f8SToomas Soome /*
566*199767f8SToomas Soome  * The following macros optimize certain frequently calculated
567*199767f8SToomas Soome  * quantities by using shifts and masks in place of divisions
568*199767f8SToomas Soome  * modulos and multiplications.
569*199767f8SToomas Soome  */
570*199767f8SToomas Soome #define	blkoff(fs, loc)		/* calculates (loc % fs->fs_bsize) */ \
571*199767f8SToomas Soome 	((loc) & ~((fs)->fs_bmask))
572*199767f8SToomas Soome #define	fragoff(fs, loc)	/* calculates (loc % fs->fs_fsize) */ \
573*199767f8SToomas Soome 	((loc) & ~((fs)->fs_fmask))
574*199767f8SToomas Soome #define	lfragtosize(fs, frag)	/* calculates ((off_t)frag * fs->fs_fsize) */ \
575*199767f8SToomas Soome 	(((off_t)(frag)) << (fs)->fs_fshift)
576*199767f8SToomas Soome #define	lblktosize(fs, blk)	/* calculates ((off_t)blk * fs->fs_bsize) */ \
577*199767f8SToomas Soome 	(((off_t)(blk)) << (fs)->fs_bshift)
578*199767f8SToomas Soome /* Use this only when `blk' is known to be small, e.g., < NDADDR. */
579*199767f8SToomas Soome #define	smalllblktosize(fs, blk)    /* calculates (blk * fs->fs_bsize) */ \
580*199767f8SToomas Soome 	((blk) << (fs)->fs_bshift)
581*199767f8SToomas Soome #define	lblkno(fs, loc)		/* calculates (loc / fs->fs_bsize) */ \
582*199767f8SToomas Soome 	((loc) >> (fs)->fs_bshift)
583*199767f8SToomas Soome #define	numfrags(fs, loc)	/* calculates (loc / fs->fs_fsize) */ \
584*199767f8SToomas Soome 	((loc) >> (fs)->fs_fshift)
585*199767f8SToomas Soome #define	blkroundup(fs, size)	/* calculates roundup(size, fs->fs_bsize) */ \
586*199767f8SToomas Soome 	(((size) + (fs)->fs_bsize - 1) & (fs)->fs_bmask)
587*199767f8SToomas Soome #define	fragroundup(fs, size)	/* calculates roundup(size, fs->fs_fsize) */ \
588*199767f8SToomas Soome 	(((size) + (fs)->fs_fsize - 1) & (fs)->fs_fmask)
589*199767f8SToomas Soome #define	fragstoblks(fs, frags)	/* calculates (frags / fs->fs_frag) */ \
590*199767f8SToomas Soome 	((frags) >> (fs)->fs_fragshift)
591*199767f8SToomas Soome #define	blkstofrags(fs, blks)	/* calculates (blks * fs->fs_frag) */ \
592*199767f8SToomas Soome 	((blks) << (fs)->fs_fragshift)
593*199767f8SToomas Soome #define	fragnum(fs, fsb)	/* calculates (fsb % fs->fs_frag) */ \
594*199767f8SToomas Soome 	((fsb) & ((fs)->fs_frag - 1))
595*199767f8SToomas Soome #define	blknum(fs, fsb)		/* calculates rounddown(fsb, fs->fs_frag) */ \
596*199767f8SToomas Soome 	((fsb) &~ ((fs)->fs_frag - 1))
597*199767f8SToomas Soome 
598*199767f8SToomas Soome /*
599*199767f8SToomas Soome  * Determine the number of available frags given a
600*199767f8SToomas Soome  * percentage to hold in reserve.
601*199767f8SToomas Soome  */
602*199767f8SToomas Soome #define	freespace(fs, percentreserved) \
603*199767f8SToomas Soome 	(blkstofrags((fs), (fs)->fs_cstotal.cs_nbfree) + \
604*199767f8SToomas Soome 	(fs)->fs_cstotal.cs_nffree - \
605*199767f8SToomas Soome 	(((off_t)((fs)->fs_dsize)) * (percentreserved) / 100))
606*199767f8SToomas Soome 
607*199767f8SToomas Soome /*
608*199767f8SToomas Soome  * Determining the size of a file block in the filesystem.
609*199767f8SToomas Soome  */
610*199767f8SToomas Soome #define	blksize(fs, ip, lbn) \
611*199767f8SToomas Soome 	(((lbn) >= NDADDR || (ip)->i_size >= smalllblktosize(fs, (lbn) + 1)) \
612*199767f8SToomas Soome 	    ? (fs)->fs_bsize \
613*199767f8SToomas Soome 	    : (fragroundup(fs, blkoff(fs, (ip)->i_size))))
614*199767f8SToomas Soome #define	sblksize(fs, size, lbn) \
615*199767f8SToomas Soome 	(((lbn) >= NDADDR || (size) >= ((lbn) + 1) << (fs)->fs_bshift) \
616*199767f8SToomas Soome 	  ? (fs)->fs_bsize \
617*199767f8SToomas Soome 	  : (fragroundup(fs, blkoff(fs, (size)))))
618*199767f8SToomas Soome 
619*199767f8SToomas Soome /*
620*199767f8SToomas Soome  * Number of indirects in a filesystem block.
621*199767f8SToomas Soome  */
622*199767f8SToomas Soome #define	NINDIR(fs)	((fs)->fs_nindir)
623*199767f8SToomas Soome 
624*199767f8SToomas Soome /*
625*199767f8SToomas Soome  * Indirect lbns are aligned on NDADDR addresses where single indirects
626*199767f8SToomas Soome  * are the negated address of the lowest lbn reachable, double indirects
627*199767f8SToomas Soome  * are this lbn - 1 and triple indirects are this lbn - 2.  This yields
628*199767f8SToomas Soome  * an unusual bit order to determine level.
629*199767f8SToomas Soome  */
630*199767f8SToomas Soome static inline int
lbn_level(ufs_lbn_t lbn)631*199767f8SToomas Soome lbn_level(ufs_lbn_t lbn)
632*199767f8SToomas Soome {
633*199767f8SToomas Soome 	if (lbn >= 0)
634*199767f8SToomas Soome 		return 0;
635*199767f8SToomas Soome 	switch (lbn & 0x3) {
636*199767f8SToomas Soome 	case 0:
637*199767f8SToomas Soome 		return (0);
638*199767f8SToomas Soome 	case 1:
639*199767f8SToomas Soome 		break;
640*199767f8SToomas Soome 	case 2:
641*199767f8SToomas Soome 		return (2);
642*199767f8SToomas Soome 	case 3:
643*199767f8SToomas Soome 		return (1);
644*199767f8SToomas Soome 	default:
645*199767f8SToomas Soome 		break;
646*199767f8SToomas Soome 	}
647*199767f8SToomas Soome 	return (-1);
648*199767f8SToomas Soome }
649*199767f8SToomas Soome 
650*199767f8SToomas Soome static inline ufs_lbn_t
lbn_offset(struct fs * fs,int level)651*199767f8SToomas Soome lbn_offset(struct fs *fs, int level)
652*199767f8SToomas Soome {
653*199767f8SToomas Soome 	ufs_lbn_t res;
654*199767f8SToomas Soome 
655*199767f8SToomas Soome 	for (res = 1; level > 0; level--)
656*199767f8SToomas Soome 		res *= NINDIR(fs);
657*199767f8SToomas Soome 	return (res);
658*199767f8SToomas Soome }
659*199767f8SToomas Soome 
660*199767f8SToomas Soome /*
661*199767f8SToomas Soome  * Number of inodes in a secondary storage block/fragment.
662*199767f8SToomas Soome  */
663*199767f8SToomas Soome #define	INOPB(fs)	((fs)->fs_inopb)
664*199767f8SToomas Soome #define	INOPF(fs)	((fs)->fs_inopb >> (fs)->fs_fragshift)
665*199767f8SToomas Soome 
666*199767f8SToomas Soome /*
667*199767f8SToomas Soome  * Softdep journal record format.
668*199767f8SToomas Soome  */
669*199767f8SToomas Soome 
670*199767f8SToomas Soome #define	JOP_ADDREF	1	/* Add a reference to an inode. */
671*199767f8SToomas Soome #define	JOP_REMREF	2	/* Remove a reference from an inode. */
672*199767f8SToomas Soome #define	JOP_NEWBLK	3	/* Allocate a block. */
673*199767f8SToomas Soome #define	JOP_FREEBLK	4	/* Free a block or a tree of blocks. */
674*199767f8SToomas Soome #define	JOP_MVREF	5	/* Move a reference from one off to another. */
675*199767f8SToomas Soome #define	JOP_TRUNC	6	/* Partial truncation record. */
676*199767f8SToomas Soome #define	JOP_SYNC	7	/* fsync() complete record. */
677*199767f8SToomas Soome 
678*199767f8SToomas Soome #define	JREC_SIZE	32	/* Record and segment header size. */
679*199767f8SToomas Soome 
680*199767f8SToomas Soome #define	SUJ_MIN		(4 * 1024 * 1024)	/* Minimum journal size */
681*199767f8SToomas Soome #define	SUJ_MAX		(32 * 1024 * 1024)	/* Maximum journal size */
682*199767f8SToomas Soome #define	SUJ_FILE	".sujournal"		/* Journal file name */
683*199767f8SToomas Soome 
684*199767f8SToomas Soome /*
685*199767f8SToomas Soome  * Size of the segment record header.  There is at most one for each disk
686*199767f8SToomas Soome  * block in the journal.  The segment header is followed by an array of
687*199767f8SToomas Soome  * records.  fsck depends on the first element in each record being 'op'
688*199767f8SToomas Soome  * and the second being 'ino'.  Segments may span multiple disk blocks but
689*199767f8SToomas Soome  * the header is present on each.
690*199767f8SToomas Soome  */
691*199767f8SToomas Soome struct jsegrec {
692*199767f8SToomas Soome 	uint64_t	jsr_seq;	/* Our sequence number */
693*199767f8SToomas Soome 	uint64_t	jsr_oldest;	/* Oldest valid sequence number */
694*199767f8SToomas Soome 	uint16_t	jsr_cnt;	/* Count of valid records */
695*199767f8SToomas Soome 	uint16_t	jsr_blocks;	/* Count of device bsize blocks. */
696*199767f8SToomas Soome 	uint32_t	jsr_crc;	/* 32bit crc of the valid space */
697*199767f8SToomas Soome 	ufs_time_t	jsr_time;	/* timestamp for mount instance */
698*199767f8SToomas Soome };
699*199767f8SToomas Soome 
700*199767f8SToomas Soome /*
701*199767f8SToomas Soome  * Reference record.  Records a single link count modification.
702*199767f8SToomas Soome  */
703*199767f8SToomas Soome struct jrefrec {
704*199767f8SToomas Soome 	uint32_t	jr_op;
705*199767f8SToomas Soome 	uint32_t	jr_ino;
706*199767f8SToomas Soome 	uint32_t	jr_parent;
707*199767f8SToomas Soome 	uint16_t	jr_nlink;
708*199767f8SToomas Soome 	uint16_t	jr_mode;
709*199767f8SToomas Soome 	int64_t		jr_diroff;
710*199767f8SToomas Soome 	uint64_t	jr_unused;
711*199767f8SToomas Soome };
712*199767f8SToomas Soome 
713*199767f8SToomas Soome /*
714*199767f8SToomas Soome  * Move record.  Records a reference moving within a directory block.  The
715*199767f8SToomas Soome  * nlink is unchanged but we must search both locations.
716*199767f8SToomas Soome  */
717*199767f8SToomas Soome struct jmvrec {
718*199767f8SToomas Soome 	uint32_t	jm_op;
719*199767f8SToomas Soome 	uint32_t	jm_ino;
720*199767f8SToomas Soome 	uint32_t	jm_parent;
721*199767f8SToomas Soome 	uint16_t	jm_unused;
722*199767f8SToomas Soome 	int64_t		jm_oldoff;
723*199767f8SToomas Soome 	int64_t		jm_newoff;
724*199767f8SToomas Soome };
725*199767f8SToomas Soome 
726*199767f8SToomas Soome /*
727*199767f8SToomas Soome  * Block record.  A set of frags or tree of blocks starting at an indirect are
728*199767f8SToomas Soome  * freed or a set of frags are allocated.
729*199767f8SToomas Soome  */
730*199767f8SToomas Soome struct jblkrec {
731*199767f8SToomas Soome 	uint32_t	jb_op;
732*199767f8SToomas Soome 	uint32_t	jb_ino;
733*199767f8SToomas Soome 	ufs2_daddr_t	jb_blkno;
734*199767f8SToomas Soome 	ufs_lbn_t	jb_lbn;
735*199767f8SToomas Soome 	uint16_t	jb_frags;
736*199767f8SToomas Soome 	uint16_t	jb_oldfrags;
737*199767f8SToomas Soome 	uint32_t	jb_unused;
738*199767f8SToomas Soome };
739*199767f8SToomas Soome 
740*199767f8SToomas Soome /*
741*199767f8SToomas Soome  * Truncation record.  Records a partial truncation so that it may be
742*199767f8SToomas Soome  * completed at check time.  Also used for sync records.
743*199767f8SToomas Soome  */
744*199767f8SToomas Soome struct jtrncrec {
745*199767f8SToomas Soome 	uint32_t	jt_op;
746*199767f8SToomas Soome 	uint32_t	jt_ino;
747*199767f8SToomas Soome 	int64_t		jt_size;
748*199767f8SToomas Soome 	uint32_t	jt_extsize;
749*199767f8SToomas Soome 	uint32_t	jt_pad[3];
750*199767f8SToomas Soome };
751*199767f8SToomas Soome 
752*199767f8SToomas Soome union jrec {
753*199767f8SToomas Soome 	struct jsegrec	rec_jsegrec;
754*199767f8SToomas Soome 	struct jrefrec	rec_jrefrec;
755*199767f8SToomas Soome 	struct jmvrec	rec_jmvrec;
756*199767f8SToomas Soome 	struct jblkrec	rec_jblkrec;
757*199767f8SToomas Soome 	struct jtrncrec	rec_jtrncrec;
758*199767f8SToomas Soome };
759*199767f8SToomas Soome 
760*199767f8SToomas Soome #ifdef CTASSERT
761*199767f8SToomas Soome CTASSERT(sizeof(struct jsegrec) == JREC_SIZE);
762*199767f8SToomas Soome CTASSERT(sizeof(struct jrefrec) == JREC_SIZE);
763*199767f8SToomas Soome CTASSERT(sizeof(struct jmvrec) == JREC_SIZE);
764*199767f8SToomas Soome CTASSERT(sizeof(struct jblkrec) == JREC_SIZE);
765*199767f8SToomas Soome CTASSERT(sizeof(struct jtrncrec) == JREC_SIZE);
766*199767f8SToomas Soome CTASSERT(sizeof(union jrec) == JREC_SIZE);
767*199767f8SToomas Soome #endif
768*199767f8SToomas Soome 
769*199767f8SToomas Soome extern int inside[], around[];
770*199767f8SToomas Soome extern u_char *fragtbl[];
771*199767f8SToomas Soome 
772*199767f8SToomas Soome /*
773*199767f8SToomas Soome  * IOCTLs used for filesystem write suspension.
774*199767f8SToomas Soome  */
775*199767f8SToomas Soome #define	UFSSUSPEND	_IOW('U', 1, fsid_t)
776*199767f8SToomas Soome #define	UFSRESUME	_IO('U', 2)
777*199767f8SToomas Soome 
778*199767f8SToomas Soome #endif
779