xref: /freebsd/sys/fs/ext2fs/fs.h (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1 /*-
2  *  modified for EXT2FS support in Lites 1.1
3  *
4  *  Aug 1995, Godmar Back (gback@cs.utah.edu)
5  *  University of Utah, Department of Computer Science
6  */
7 /*-
8  * SPDX-License-Identifier: BSD-3-Clause
9  *
10  * Copyright (c) 1982, 1986, 1993
11  *	The Regents of the University of California.  All rights reserved.
12  *
13  * Redistribution and use in source and binary forms, with or without
14  * modification, are permitted provided that the following conditions
15  * are met:
16  * 1. Redistributions of source code must retain the above copyright
17  *    notice, this list of conditions and the following disclaimer.
18  * 2. Redistributions in binary form must reproduce the above copyright
19  *    notice, this list of conditions and the following disclaimer in the
20  *    documentation and/or other materials provided with the distribution.
21  * 3. Neither the name of the University nor the names of its contributors
22  *    may be used to endorse or promote products derived from this software
23  *    without specific prior written permission.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35  * SUCH DAMAGE.
36  *
37  *	@(#)fs.h	8.7 (Berkeley) 4/19/94
38  * $FreeBSD$
39  */
40 
41 #ifndef _FS_EXT2FS_FS_H_
42 #define	_FS_EXT2FS_FS_H_
43 
44 /*
45  * Each disk drive contains some number of file systems.
46  * A file system consists of a number of cylinder groups.
47  * Each cylinder group has inodes and data.
48  *
49  * A file system is described by its super-block, which in turn
50  * describes the cylinder groups.  The super-block is critical
51  * data and is replicated in each cylinder group to protect against
52  * catastrophic loss.  This is done at `newfs' time and the critical
53  * super-block data does not change, so the copies need not be
54  * referenced further unless disaster strikes.
55  *
56  * The first boot and super blocks are given in absolute disk addresses.
57  * The byte-offset forms are preferred, as they don't imply a sector size.
58  */
59 #define	SBLOCK		0
60 #define	SBLOCKSIZE	1024
61 #define	SBLOCKOFFSET	1024
62 #define	SBLOCKBLKSIZE	4096
63 
64 /*
65  * The path name on which the file system is mounted is maintained
66  * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in
67  * the super block for this name.
68  */
69 #define	MAXMNTLEN	512
70 
71 /*
72  * A summary of contiguous blocks of various sizes is maintained
73  * in each cylinder group. Normally this is set by the initial
74  * value of fs_maxcontig.
75  *
76  * XXX:FS_MAXCONTIG is set to 16 to conserve space. Here we set
77  * EXT2_MAXCONTIG to 32 for better performance.
78  */
79 #define	EXT2_MAXCONTIG	32
80 
81 /*
82  * Grigoriy Orlov <gluk@ptci.ru> has done some extensive work to fine
83  * tune the layout preferences for directories within a filesystem.
84  * His algorithm can be tuned by adjusting the following parameters
85  * which tell the system the average file size and the average number
86  * of files per directory. These defaults are well selected for typical
87  * filesystems, but may need to be tuned for odd cases like filesystems
88  * being used for squid caches or news spools.
89  * AVFPDIR is the expected number of files per directory. AVGDIRSIZE is
90  * obtained by multiplying AVFPDIR and AVFILESIZ which is assumed to be
91  * 16384.
92  */
93 
94 #define	AFPDIR		64
95 #define	AVGDIRSIZE	1048576
96 
97 /*
98  * Macros for access to superblock array structures
99  */
100 
101 /*
102  * Turn file system block numbers into disk block addresses.
103  * This maps file system blocks to device size blocks.
104  */
105 #define	fsbtodb(fs, b)	((daddr_t)(b) << (fs)->e2fs_fsbtodb)
106 #define	dbtofsb(fs, b)	((b) >> (fs)->e2fs_fsbtodb)
107 
108 /* get group containing inode */
109 #define	ino_to_cg(fs, x)	(((x) - 1) / (fs->e2fs_ipg))
110 
111 /* get block containing inode from its number x */
112 #define	ino_to_fsba(fs, x)                                              \
113 	(e2fs_gd_get_i_tables(&(fs)->e2fs_gd[ino_to_cg((fs), (x))]) +   \
114 	    (((x) - 1) % (fs)->e2fs_ipg) / (fs)->e2fs_ipb)
115 
116 /* get offset for inode in block */
117 #define	ino_to_fsbo(fs, x)	((x-1) % (fs->e2fs_ipb))
118 
119 /*
120  * Give cylinder group number for a file system block.
121  * Give cylinder group block number for a file system block.
122  */
123 #define	dtog(fs, d)	(((d) - le32toh(fs->e2fs->e2fs_first_dblock)) / \
124     EXT2_BLOCKS_PER_GROUP(fs))
125 #define	dtogd(fs, d)	(((d) - le32toh(fs->e2fs->e2fs_first_dblock)) % \
126     EXT2_BLOCKS_PER_GROUP(fs))
127 
128 /*
129  * The following macros optimize certain frequently calculated
130  * quantities by using shifts and masks in place of divisions
131  * modulos and multiplications.
132  */
133 #define	blkoff(fs, loc)		/* calculates (loc % fs->fs_bsize) */ \
134 	((loc) & (fs)->e2fs_qbmask)
135 
136 #define	lblktosize(fs, blk)	/* calculates (blk * fs->fs_bsize) */ \
137 	((blk) << (fs->e2fs_bshift))
138 
139 #define	lblkno(fs, loc)		/* calculates (loc / fs->fs_bsize) */ \
140 	((loc) >> (fs->e2fs_bshift))
141 
142 /* no fragments -> logical block number equal # of frags */
143 #define	numfrags(fs, loc)	/* calculates (loc / fs->fs_fsize) */ \
144 	((loc) >> (fs->e2fs_bshift))
145 
146 #define	fragroundup(fs, size)	/* calculates roundup(size, fs->fs_fsize) */ \
147 	roundup(size, fs->e2fs_fsize)
148 	/* was (((size) + (fs)->fs_qfmask) & (fs)->fs_fmask) */
149 
150 /*
151  * Determining the size of a file block in the file system.
152  * easy w/o fragments
153  */
154 #define	blksize(fs, ip, lbn) ((fs)->e2fs_fsize)
155 
156 /*
157  * INOPB is the number of inodes in a secondary storage block.
158  */
159 #define	INOPB(fs)	(fs->e2fs_ipb)
160 
161 /*
162  * NINDIR is the number of indirects in a file system block.
163  */
164 #define	NINDIR(fs)	(EXT2_ADDR_PER_BLOCK(fs))
165 
166 /*
167  * Use if additional debug logging is required.
168  */
169 /* #define	EXT2FS_PRINT_EXTENTS */
170 
171 #endif	/* !_FS_EXT2FS_FS_H_ */
172