2 * modified for EXT2FS support in Lites 1.1
4 * Aug 1995, Godmar Back (gback@cs.utah.edu)
5 * University of Utah, Department of Computer Science
10 * Copyright (c) 2009 Aditya Sarawgi
11 * All rights reserved.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
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.
22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 #ifndef _FS_EXT2FS_EXT2FS_H_
38 #define _FS_EXT2FS_EXT2FS_H_
40 #include <sys/types.h>
43 * Super block for an ext2fs file system.
46 uint32_t e2fs_icount; /* Inode count */
47 uint32_t e2fs_bcount; /* blocks count */
48 uint32_t e2fs_rbcount; /* reserved blocks count */
49 uint32_t e2fs_fbcount; /* free blocks count */
50 uint32_t e2fs_ficount; /* free inodes count */
51 uint32_t e2fs_first_dblock; /* first data block */
52 uint32_t e2fs_log_bsize; /* block size = 1024*(2^e2fs_log_bsize) */
53 uint32_t e2fs_log_fsize; /* fragment size */
54 uint32_t e2fs_bpg; /* blocks per group */
55 uint32_t e2fs_fpg; /* frags per group */
56 uint32_t e2fs_ipg; /* inodes per group */
57 uint32_t e2fs_mtime; /* mount time */
58 uint32_t e2fs_wtime; /* write time */
59 uint16_t e2fs_mnt_count; /* mount count */
60 uint16_t e2fs_max_mnt_count; /* max mount count */
61 uint16_t e2fs_magic; /* magic number */
62 uint16_t e2fs_state; /* file system state */
63 uint16_t e2fs_beh; /* behavior on errors */
64 uint16_t e2fs_minrev; /* minor revision level */
65 uint32_t e2fs_lastfsck; /* time of last fsck */
66 uint32_t e2fs_fsckintv; /* max time between fscks */
67 uint32_t e2fs_creator; /* creator OS */
68 uint32_t e2fs_rev; /* revision level */
69 uint16_t e2fs_ruid; /* default uid for reserved blocks */
70 uint16_t e2fs_rgid; /* default gid for reserved blocks */
71 /* EXT2_DYNAMIC_REV superblocks */
72 uint32_t e2fs_first_ino; /* first non-reserved inode */
73 uint16_t e2fs_inode_size; /* size of inode structure */
74 uint16_t e2fs_block_group_nr; /* block grp number of this sblk*/
75 uint32_t e2fs_features_compat; /* compatible feature set */
76 uint32_t e2fs_features_incompat; /* incompatible feature set */
77 uint32_t e2fs_features_rocompat; /* RO-compatible feature set */
78 uint8_t e2fs_uuid[16]; /* 128-bit uuid for volume */
79 char e2fs_vname[16]; /* volume name */
80 char e2fs_fsmnt[64]; /* name mounted on */
81 uint32_t e2fs_algo; /* For compression */
82 uint8_t e2fs_prealloc; /* # of blocks for old prealloc */
83 uint8_t e2fs_dir_prealloc; /* # of blocks for old prealloc dirs */
84 uint16_t e2fs_reserved_ngdb; /* # of reserved gd blocks for resize */
85 char e3fs_journal_uuid[16]; /* uuid of journal superblock */
86 uint32_t e3fs_journal_inum; /* inode number of journal file */
87 uint32_t e3fs_journal_dev; /* device number of journal file */
88 uint32_t e3fs_last_orphan; /* start of list of inodes to delete */
89 uint32_t e3fs_hash_seed[4]; /* HTREE hash seed */
90 char e3fs_def_hash_version; /* Default hash version to use */
91 char e3fs_jnl_backup_type;
92 uint16_t e3fs_desc_size; /* size of group descriptor */
93 uint32_t e3fs_default_mount_opts;
94 uint32_t e3fs_first_meta_bg; /* First metablock block group */
95 uint32_t e3fs_mkfs_time; /* when the fs was created */
96 uint32_t e3fs_jnl_blks[17]; /* backup of the journal inode */
97 uint32_t e4fs_bcount_hi; /* high bits of blocks count */
98 uint32_t e4fs_rbcount_hi; /* high bits of reserved blocks count */
99 uint32_t e4fs_fbcount_hi; /* high bits of free blocks count */
100 uint16_t e4fs_min_extra_isize; /* all inodes have at least some bytes */
101 uint16_t e4fs_want_extra_isize; /* inodes must reserve some bytes */
102 uint32_t e4fs_flags; /* miscellaneous flags */
103 uint16_t e4fs_raid_stride; /* RAID stride */
104 uint16_t e4fs_mmpintv; /* number of seconds to wait in MMP checking */
105 uint64_t e4fs_mmpblk; /* block for multi-mount protection */
106 uint32_t e4fs_raid_stripe_wid; /* blocks on all data disks (N * stride) */
107 uint8_t e4fs_log_gpf; /* FLEX_BG group size */
108 uint8_t e4fs_chksum_type; /* metadata checksum algorithm used */
109 uint8_t e4fs_encrypt; /* versioning level for encryption */
110 uint8_t e4fs_reserved_pad;
111 uint64_t e4fs_kbytes_written; /* number of lifetime kilobytes */
112 uint32_t e4fs_snapinum; /* inode number of active snapshot */
113 uint32_t e4fs_snapid; /* sequential ID of active snapshot */
114 uint64_t e4fs_snaprbcount; /* reserved blocks for active snapshot */
115 uint32_t e4fs_snaplist; /* inode number for on-disk snapshot */
116 uint32_t e4fs_errcount; /* number of file system errors */
117 uint32_t e4fs_first_errtime; /* first time an error happened */
118 uint32_t e4fs_first_errino; /* inode involved in first error */
119 uint64_t e4fs_first_errblk; /* block involved of first error */
120 uint8_t e4fs_first_errfunc[32]; /* function where error happened */
121 uint32_t e4fs_first_errline; /* line number where error happened */
122 uint32_t e4fs_last_errtime; /* most recent time of an error */
123 uint32_t e4fs_last_errino; /* inode involved in last error */
124 uint32_t e4fs_last_errline; /* line number where error happened */
125 uint64_t e4fs_last_errblk; /* block involved of last error */
126 uint8_t e4fs_last_errfunc[32]; /* function where error happened */
127 uint8_t e4fs_mount_opts[64];
128 uint32_t e4fs_usrquota_inum; /* inode for tracking user quota */
129 uint32_t e4fs_grpquota_inum; /* inode for tracking group quota */
130 uint32_t e4fs_overhead_clusters; /* overhead blocks/clusters */
131 uint32_t e4fs_backup_bgs[2]; /* groups with sparse_super2 SBs */
132 uint8_t e4fs_encrypt_algos[4]; /* encryption algorithms in use */
133 uint8_t e4fs_encrypt_pw_salt[16]; /* salt used for string2key */
134 uint32_t e4fs_lpf_ino; /* location of the lost+found inode */
135 uint32_t e4fs_proj_quota_inum; /* inode for tracking project quota */
136 uint32_t e4fs_chksum_seed; /* checksum seed */
137 uint32_t e4fs_reserved[98]; /* padding to the end of the block */
138 uint32_t e4fs_sbchksum; /* superblock checksum */
142 * The path name on which the file system is mounted is maintained
143 * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in
144 * the super block for this name.
146 #define MAXMNTLEN 512
149 * In-Memory Superblock
153 struct ext2fs * e2fs;
154 char e2fs_fsmnt[MAXMNTLEN];/* name mounted on */
155 char e2fs_ronly; /* mounted read-only flag */
156 char e2fs_fmod; /* super block modified flag */
157 uint32_t e2fs_bsize; /* Block size */
158 uint32_t e2fs_bshift; /* calc of logical block no */
159 uint32_t e2fs_bpg; /* Number of blocks per group */
160 int64_t e2fs_qbmask; /* = s_blocksize -1 */
161 uint32_t e2fs_fsbtodb; /* Shift to get disk block */
162 uint32_t e2fs_ipg; /* Number of inodes per group */
163 uint32_t e2fs_ipb; /* Number of inodes per block */
164 uint32_t e2fs_itpg; /* Number of inode table per group */
165 uint32_t e2fs_fsize; /* Size of fragments per block */
166 uint32_t e2fs_fpb; /* Number of fragments per block */
167 uint32_t e2fs_fpg; /* Number of fragments per group */
168 uint32_t e2fs_gdbcount; /* Number of group descriptors */
169 uint32_t e2fs_gcount; /* Number of groups */
170 uint32_t e2fs_isize; /* Size of inode */
171 uint32_t e2fs_total_dir; /* Total number of directories */
172 uint8_t *e2fs_contigdirs; /* (u) # of contig. allocated dirs */
173 char e2fs_wasvalid; /* valid at mount time */
174 off_t e2fs_maxfilesize;
175 struct ext2_gd *e2fs_gd; /* Group Descriptors */
176 int32_t e2fs_contigsumsize; /* size of cluster summary array */
177 int32_t *e2fs_maxcluster; /* max cluster in each cyl group */
178 struct csum *e2fs_clustersum; /* cluster summary in each cyl group */
179 int32_t e2fs_uhash; /* 3 if hash should be signed, 0 if not */
182 /* cluster summary information */
185 int8_t cs_init; /* cluster summary has been initialized */
186 int32_t *cs_sum; /* cluster summary array */
190 * The second extended file system magic number
192 #define E2FS_MAGIC 0xEF53
197 #define E2FS_REV0 0 /* The good old (original) format */
198 #define E2FS_REV1 1 /* V2 format w/ dynamic inode sizes */
200 #define E2FS_REV0_INODE_SIZE 128
203 * compatible/incompatible features
205 #define EXT2F_COMPAT_PREALLOC 0x0001
206 #define EXT2F_COMPAT_HASJOURNAL 0x0004
207 #define EXT2F_COMPAT_RESIZE 0x0010
208 #define EXT2F_COMPAT_DIRHASHINDEX 0x0020
210 #define EXT2F_ROCOMPAT_SPARSESUPER 0x0001
211 #define EXT2F_ROCOMPAT_LARGEFILE 0x0002
212 #define EXT2F_ROCOMPAT_BTREE_DIR 0x0004
213 #define EXT2F_ROCOMPAT_HUGE_FILE 0x0008
214 #define EXT2F_ROCOMPAT_GDT_CSUM 0x0010
215 #define EXT2F_ROCOMPAT_DIR_NLINK 0x0020
216 #define EXT2F_ROCOMPAT_EXTRA_ISIZE 0x0040
218 #define EXT2F_INCOMPAT_COMP 0x0001
219 #define EXT2F_INCOMPAT_FTYPE 0x0002
220 #define EXT2F_INCOMPAT_RECOVER 0x0004
221 #define EXT2F_INCOMPAT_META_BG 0x0010
222 #define EXT2F_INCOMPAT_EXTENTS 0x0040
223 #define EXT2F_INCOMPAT_64BIT 0x0080
224 #define EXT2F_INCOMPAT_MMP 0x0100
225 #define EXT2F_INCOMPAT_FLEX_BG 0x0200
228 * Features supported in this implementation
230 * We support the following REV1 features:
231 * - EXT2F_ROCOMPAT_SPARSESUPER
232 * - EXT2F_ROCOMPAT_LARGEFILE
233 * - EXT2F_ROCOMPAT_EXTRA_ISIZE
234 * - EXT2F_INCOMPAT_FTYPE
236 * We partially (read-only) support the following EXT4 features:
237 * - EXT2F_ROCOMPAT_HUGE_FILE
238 * - EXT2F_INCOMPAT_EXTENTS
240 * We do not support these EXT4 features but they are irrelevant
241 * for read-only support:
242 * - EXT2F_INCOMPAT_RECOVER
243 * - EXT2F_INCOMPAT_FLEX_BG
244 * - EXT2F_INCOMPAT_META_BG
246 #define EXT2F_COMPAT_SUPP EXT2F_COMPAT_DIRHASHINDEX
247 #define EXT2F_ROCOMPAT_SUPP (EXT2F_ROCOMPAT_SPARSESUPER | \
248 EXT2F_ROCOMPAT_LARGEFILE | \
249 EXT2F_ROCOMPAT_EXTRA_ISIZE)
250 #define EXT2F_INCOMPAT_SUPP EXT2F_INCOMPAT_FTYPE
251 #define EXT4F_RO_INCOMPAT_SUPP (EXT2F_INCOMPAT_EXTENTS | \
252 EXT2F_INCOMPAT_RECOVER | \
253 EXT2F_INCOMPAT_FLEX_BG | \
254 EXT2F_INCOMPAT_META_BG )
256 /* Assume that user mode programs are passing in an ext2fs superblock, not
257 * a kernel struct super_block. This will allow us to call the feature-test
258 * macros from user land. */
259 #define EXT2_SB(sb) (sb)
262 * Feature set definitions
264 #define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
265 ( EXT2_SB(sb)->e2fs->e2fs_features_compat & htole32(mask) )
266 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
267 ( EXT2_SB(sb)->e2fs->e2fs_features_rocompat & htole32(mask) )
268 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
269 ( EXT2_SB(sb)->e2fs->e2fs_features_incompat & htole32(mask) )
274 #define E2FS_ISCLEAN 0x0001 /* Unmounted cleanly */
275 #define E2FS_ERRORS 0x0002 /* Errors detected */
278 * Filesystem miscellaneous flags
280 #define E2FS_SIGNED_HASH 0x0001
281 #define E2FS_UNSIGNED_HASH 0x0002
283 /* ext2 file system block group descriptor */
286 uint32_t ext2bgd_b_bitmap; /* blocks bitmap block */
287 uint32_t ext2bgd_i_bitmap; /* inodes bitmap block */
288 uint32_t ext2bgd_i_tables; /* inodes table block */
289 uint16_t ext2bgd_nbfree; /* number of free blocks */
290 uint16_t ext2bgd_nifree; /* number of free inodes */
291 uint16_t ext2bgd_ndirs; /* number of directories */
292 uint16_t ext4bgd_flags; /* block group flags */
293 uint32_t ext4bgd_x_bitmap; /* snapshot exclusion bitmap loc. */
294 uint16_t ext4bgd_b_bmap_csum; /* block bitmap checksum */
295 uint16_t ext4bgd_i_bmap_csum; /* inode bitmap checksum */
296 uint16_t ext4bgd_i_unused; /* unused inode count */
297 uint16_t ext4bgd_csum; /* group descriptor checksum */
301 /* EXT2FS metadatas are stored in little-endian byte order. These macros
302 * helps reading these metadatas
305 #define e2fs_cgload(old, new, size) memcpy((new), (old), (size));
306 #define e2fs_cgsave(old, new, size) memcpy((new), (old), (size));
309 * Macro-instructions used to manage several block sizes
311 #define EXT2_MAX_BLOCK_SIZE 4096
312 #define EXT2_MIN_BLOCK_LOG_SIZE 10
313 #define EXT2_BLOCK_SIZE(s) ((s)->e2fs_bsize)
314 #define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof(uint32_t))
315 #define EXT2_INODE_SIZE(s) (EXT2_SB(s)->e2fs_isize)
318 * Macro-instructions used to manage fragments
320 #define EXT2_MIN_FRAG_SIZE 1024
321 #define EXT2_MAX_FRAG_SIZE 4096
322 #define EXT2_MIN_FRAG_LOG_SIZE 10
323 #define EXT2_FRAG_SIZE(s) (EXT2_SB(s)->e2fs_fsize)
324 #define EXT2_FRAGS_PER_BLOCK(s) (EXT2_SB(s)->e2fs_fpb)
327 * Macro-instructions used to manage group descriptors
329 #define EXT2_BLOCKS_PER_GROUP(s) (EXT2_SB(s)->e2fs_bpg)
331 #endif /* !_FS_EXT2FS_EXT2FS_H_ */