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