1202283Slulf/*- 2202283Slulf * modified for EXT2FS support in Lites 1.1 3202283Slulf * 4202283Slulf * Aug 1995, Godmar Back (gback@cs.utah.edu) 5202283Slulf * University of Utah, Department of Computer Science 6202283Slulf * 7202283Slulf * $FreeBSD: stable/10/sys/fs/ext2fs/ext2fs.h 320839 2017-07-09 15:09:15Z pfg $ 8202283Slulf */ 9202283Slulf/*- 10202283Slulf * Copyright (c) 2009 Aditya Sarawgi 11202283Slulf * All rights reserved. 12202283Slulf * 13202283Slulf * Redistribution and use in source and binary forms, with or without 14202283Slulf * modification, are permitted provided that the following conditions 15202283Slulf * are met: 16202283Slulf * 1. Redistributions of source code must retain the above copyright 17202283Slulf * notice, this list of conditions and the following disclaimer. 18202283Slulf * 2. Redistributions in binary form must reproduce the above copyright 19202283Slulf * notice, this list of conditions and the following disclaimer in the 20202283Slulf * documentation and/or other materials provided with the distribution. 21202283Slulf * 22202283Slulf * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 23202283Slulf * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24202283Slulf * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25202283Slulf * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 26202283Slulf * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27202283Slulf * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28202283Slulf * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29202283Slulf * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30202283Slulf * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31202283Slulf * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32202283Slulf * SUCH DAMAGE. 33202283Slulf * 34311232Spfg * 35202283Slulf */ 36202283Slulf 37228583Spfg#ifndef _FS_EXT2FS_EXT2FS_H_ 38262723Spfg#define _FS_EXT2FS_EXT2FS_H_ 39202283Slulf 40202283Slulf#include <sys/types.h> 41202283Slulf 42202283Slulf/* 43202283Slulf * Super block for an ext2fs file system. 44202283Slulf */ 45202283Slulfstruct ext2fs { 46221126Sjhb uint32_t e2fs_icount; /* Inode count */ 47221126Sjhb uint32_t e2fs_bcount; /* blocks count */ 48221126Sjhb uint32_t e2fs_rbcount; /* reserved blocks count */ 49221126Sjhb uint32_t e2fs_fbcount; /* free blocks count */ 50221126Sjhb uint32_t e2fs_ficount; /* free inodes count */ 51221126Sjhb uint32_t e2fs_first_dblock; /* first data block */ 52221126Sjhb uint32_t e2fs_log_bsize; /* block size = 1024*(2^e2fs_log_bsize) */ 53221126Sjhb uint32_t e2fs_log_fsize; /* fragment size */ 54221126Sjhb uint32_t e2fs_bpg; /* blocks per group */ 55221126Sjhb uint32_t e2fs_fpg; /* frags per group */ 56221126Sjhb uint32_t e2fs_ipg; /* inodes per group */ 57221126Sjhb uint32_t e2fs_mtime; /* mount time */ 58221126Sjhb uint32_t e2fs_wtime; /* write time */ 59221126Sjhb uint16_t e2fs_mnt_count; /* mount count */ 60221126Sjhb uint16_t e2fs_max_mnt_count; /* max mount count */ 61221126Sjhb uint16_t e2fs_magic; /* magic number */ 62221126Sjhb uint16_t e2fs_state; /* file system state */ 63221126Sjhb uint16_t e2fs_beh; /* behavior on errors */ 64221126Sjhb uint16_t e2fs_minrev; /* minor revision level */ 65221126Sjhb uint32_t e2fs_lastfsck; /* time of last fsck */ 66221126Sjhb uint32_t e2fs_fsckintv; /* max time between fscks */ 67221126Sjhb uint32_t e2fs_creator; /* creator OS */ 68221126Sjhb uint32_t e2fs_rev; /* revision level */ 69221126Sjhb uint16_t e2fs_ruid; /* default uid for reserved blocks */ 70221126Sjhb uint16_t e2fs_rgid; /* default gid for reserved blocks */ 71202283Slulf /* EXT2_DYNAMIC_REV superblocks */ 72221126Sjhb uint32_t e2fs_first_ino; /* first non-reserved inode */ 73221126Sjhb uint16_t e2fs_inode_size; /* size of inode structure */ 74221126Sjhb uint16_t e2fs_block_group_nr; /* block grp number of this sblk*/ 75297480Skevlo uint32_t e2fs_features_compat; /* compatible feature set */ 76221126Sjhb uint32_t e2fs_features_incompat; /* incompatible feature set */ 77221126Sjhb uint32_t e2fs_features_rocompat; /* RO-compatible feature set */ 78221126Sjhb uint8_t e2fs_uuid[16]; /* 128-bit uuid for volume */ 79221126Sjhb char e2fs_vname[16]; /* volume name */ 80262723Spfg char e2fs_fsmnt[64]; /* name mounted on */ 81221126Sjhb uint32_t e2fs_algo; /* For compression */ 82221126Sjhb uint8_t e2fs_prealloc; /* # of blocks for old prealloc */ 83221126Sjhb uint8_t e2fs_dir_prealloc; /* # of blocks for old prealloc dirs */ 84221126Sjhb uint16_t e2fs_reserved_ngdb; /* # of reserved gd blocks for resize */ 85221126Sjhb char e3fs_journal_uuid[16]; /* uuid of journal superblock */ 86221126Sjhb uint32_t e3fs_journal_inum; /* inode number of journal file */ 87221126Sjhb uint32_t e3fs_journal_dev; /* device number of journal file */ 88221126Sjhb uint32_t e3fs_last_orphan; /* start of list of inodes to delete */ 89221126Sjhb uint32_t e3fs_hash_seed[4]; /* HTREE hash seed */ 90221126Sjhb char e3fs_def_hash_version; /* Default hash version to use */ 91297480Skevlo char e3fs_jnl_backup_type; 92297480Skevlo uint16_t e3fs_desc_size; /* size of group descriptor */ 93221126Sjhb uint32_t e3fs_default_mount_opts; 94221126Sjhb uint32_t e3fs_first_meta_bg; /* First metablock block group */ 95297480Skevlo uint32_t e3fs_mkfs_time; /* when the fs was created */ 96297480Skevlo uint32_t e3fs_jnl_blks[17]; /* backup of the journal inode */ 97297480Skevlo uint32_t e4fs_bcount_hi; /* high bits of blocks count */ 98297480Skevlo uint32_t e4fs_rbcount_hi; /* high bits of reserved blocks count */ 99297480Skevlo uint32_t e4fs_fbcount_hi; /* high bits of free blocks count */ 100297480Skevlo uint16_t e4fs_min_extra_isize; /* all inodes have at least some bytes */ 101232703Spfg uint16_t e4fs_want_extra_isize; /* inodes must reserve some bytes */ 102297480Skevlo uint32_t e4fs_flags; /* miscellaneous flags */ 103297480Skevlo uint16_t e4fs_raid_stride; /* RAID stride */ 104297480Skevlo uint16_t e4fs_mmpintv; /* number of seconds to wait in MMP checking */ 105297480Skevlo uint64_t e4fs_mmpblk; /* block for multi-mount protection */ 106297480Skevlo uint32_t e4fs_raid_stripe_wid; /* blocks on all data disks (N * stride) */ 107297480Skevlo uint8_t e4fs_log_gpf; /* FLEX_BG group size */ 108297480Skevlo uint8_t e4fs_chksum_type; /* metadata checksum algorithm used */ 109297480Skevlo uint8_t e4fs_encrypt; /* versioning level for encryption */ 110297480Skevlo uint8_t e4fs_reserved_pad; 111297480Skevlo uint64_t e4fs_kbytes_written; /* number of lifetime kilobytes */ 112297480Skevlo uint32_t e4fs_snapinum; /* inode number of active snapshot */ 113297480Skevlo uint32_t e4fs_snapid; /* sequential ID of active snapshot */ 114297480Skevlo uint64_t e4fs_snaprbcount; /* reserved blocks for active snapshot */ 115297480Skevlo uint32_t e4fs_snaplist; /* inode number for on-disk snapshot */ 116297480Skevlo uint32_t e4fs_errcount; /* number of file system errors */ 117297480Skevlo uint32_t e4fs_first_errtime; /* first time an error happened */ 118297480Skevlo uint32_t e4fs_first_errino; /* inode involved in first error */ 119297480Skevlo uint64_t e4fs_first_errblk; /* block involved of first error */ 120297480Skevlo uint8_t e4fs_first_errfunc[32]; /* function where error happened */ 121297480Skevlo uint32_t e4fs_first_errline; /* line number where error happened */ 122297480Skevlo uint32_t e4fs_last_errtime; /* most recent time of an error */ 123297480Skevlo uint32_t e4fs_last_errino; /* inode involved in last error */ 124297480Skevlo uint32_t e4fs_last_errline; /* line number where error happened */ 125297480Skevlo uint64_t e4fs_last_errblk; /* block involved of last error */ 126297480Skevlo uint8_t e4fs_last_errfunc[32]; /* function where error happened */ 127297480Skevlo uint8_t e4fs_mount_opts[64]; 128297480Skevlo uint32_t e4fs_usrquota_inum; /* inode for tracking user quota */ 129297480Skevlo uint32_t e4fs_grpquota_inum; /* inode for tracking group quota */ 130297480Skevlo uint32_t e4fs_overhead_clusters; /* overhead blocks/clusters */ 131297480Skevlo uint32_t e4fs_backup_bgs[2]; /* groups with sparse_super2 SBs */ 132297480Skevlo uint8_t e4fs_encrypt_algos[4]; /* encryption algorithms in use */ 133297480Skevlo uint8_t e4fs_encrypt_pw_salt[16]; /* salt used for string2key */ 134297480Skevlo uint32_t e4fs_lpf_ino; /* location of the lost+found inode */ 135297480Skevlo uint32_t e4fs_proj_quota_inum; /* inode for tracking project quota */ 136297480Skevlo uint32_t e4fs_chksum_seed; /* checksum seed */ 137297480Skevlo uint32_t e4fs_reserved[98]; /* padding to the end of the block */ 138297480Skevlo uint32_t e4fs_sbchksum; /* superblock checksum */ 139202283Slulf}; 140202283Slulf 141251952Spfg/* 142251952Spfg * The path name on which the file system is mounted is maintained 143251952Spfg * in fs_fsmnt. MAXMNTLEN defines the amount of space allocated in 144251952Spfg * the super block for this name. 145251952Spfg */ 146262723Spfg#define MAXMNTLEN 512 147202283Slulf 148202283Slulf/* 149202283Slulf * In-Memory Superblock 150202283Slulf */ 151202283Slulf 152202283Slulfstruct m_ext2fs { 153202283Slulf struct ext2fs * e2fs; 154221126Sjhb char e2fs_fsmnt[MAXMNTLEN];/* name mounted on */ 155262723Spfg char e2fs_ronly; /* mounted read-only flag */ 156262723Spfg char e2fs_fmod; /* super block modified flag */ 157262723Spfg uint32_t e2fs_bsize; /* Block size */ 158262723Spfg uint32_t e2fs_bshift; /* calc of logical block no */ 159251562Spfg uint32_t e2fs_bpg; /* Number of blocks per group */ 160262723Spfg int64_t e2fs_qbmask; /* = s_blocksize -1 */ 161262723Spfg uint32_t e2fs_fsbtodb; /* Shift to get disk block */ 162231168Spfg uint32_t e2fs_ipg; /* Number of inodes per group */ 163231168Spfg uint32_t e2fs_ipb; /* Number of inodes per block */ 164262723Spfg uint32_t e2fs_itpg; /* Number of inode table per group */ 165262723Spfg uint32_t e2fs_fsize; /* Size of fragments per block */ 166231168Spfg uint32_t e2fs_fpb; /* Number of fragments per block */ 167231168Spfg uint32_t e2fs_fpg; /* Number of fragments per group */ 168262723Spfg uint32_t e2fs_gdbcount; /* Number of group descriptors */ 169262723Spfg uint32_t e2fs_gcount; /* Number of groups */ 170251562Spfg uint32_t e2fs_isize; /* Size of inode */ 171202283Slulf uint32_t e2fs_total_dir; /* Total number of directories */ 172217703Sjhb uint8_t *e2fs_contigdirs; /* (u) # of contig. allocated dirs */ 173262723Spfg char e2fs_wasvalid; /* valid at mount time */ 174221126Sjhb off_t e2fs_maxfilesize; 175221126Sjhb struct ext2_gd *e2fs_gd; /* Group Descriptors */ 176228539Spfg int32_t e2fs_contigsumsize; /* size of cluster summary array */ 177228539Spfg int32_t *e2fs_maxcluster; /* max cluster in each cyl group */ 178228539Spfg struct csum *e2fs_clustersum; /* cluster summary in each cyl group */ 179296992Spfg int32_t e2fs_uhash; /* 3 if hash should be signed, 0 if not */ 180202283Slulf}; 181202283Slulf 182251809Spfg/* cluster summary information */ 183202283Slulf 184251809Spfgstruct csum { 185251809Spfg int8_t cs_init; /* cluster summary has been initialized */ 186251809Spfg int32_t *cs_sum; /* cluster summary array */ 187251809Spfg}; 188251809Spfg 189202283Slulf/* 190217703Sjhb * The second extended file system magic number 191217703Sjhb */ 192262723Spfg#define E2FS_MAGIC 0xEF53 193217703Sjhb 194217703Sjhb/* 195202283Slulf * Revision levels 196202283Slulf */ 197262723Spfg#define E2FS_REV0 0 /* The good old (original) format */ 198262723Spfg#define E2FS_REV1 1 /* V2 format w/ dynamic inode sizes */ 199202283Slulf 200262723Spfg#define E2FS_REV0_INODE_SIZE 128 201202283Slulf 202202283Slulf/* 203202283Slulf * compatible/incompatible features 204202283Slulf */ 205262723Spfg#define EXT2F_COMPAT_PREALLOC 0x0001 206262723Spfg#define EXT2F_COMPAT_HASJOURNAL 0x0004 207262723Spfg#define EXT2F_COMPAT_RESIZE 0x0010 208262723Spfg#define EXT2F_COMPAT_DIRHASHINDEX 0x0020 209305494Spfg#define EXT2F_COMPAT_SPARSESUPER2 0x0200 210202283Slulf 211262723Spfg#define EXT2F_ROCOMPAT_SPARSESUPER 0x0001 212262723Spfg#define EXT2F_ROCOMPAT_LARGEFILE 0x0002 213262723Spfg#define EXT2F_ROCOMPAT_BTREE_DIR 0x0004 214262723Spfg#define EXT2F_ROCOMPAT_HUGE_FILE 0x0008 215262723Spfg#define EXT2F_ROCOMPAT_GDT_CSUM 0x0010 216262723Spfg#define EXT2F_ROCOMPAT_DIR_NLINK 0x0020 217262723Spfg#define EXT2F_ROCOMPAT_EXTRA_ISIZE 0x0040 218305494Spfg#define EXT2F_ROCOMPAT_QUOTA 0x0100 219305494Spfg#define EXT2F_ROCOMPAT_BIGALLOC 0x0200 220305494Spfg#define EXT2F_ROCOMPAT_METADATA_CKSUM 0x0400 221305494Spfg#define EXT2F_ROCOMPAT_READONLY 0x1000 222305494Spfg#define EXT2F_ROCOMPAT_PROJECT 0x2000 223202283Slulf 224262723Spfg#define EXT2F_INCOMPAT_COMP 0x0001 225262723Spfg#define EXT2F_INCOMPAT_FTYPE 0x0002 226293236Spfg#define EXT2F_INCOMPAT_RECOVER 0x0004 227262723Spfg#define EXT2F_INCOMPAT_META_BG 0x0010 228262723Spfg#define EXT2F_INCOMPAT_EXTENTS 0x0040 229262723Spfg#define EXT2F_INCOMPAT_64BIT 0x0080 230262723Spfg#define EXT2F_INCOMPAT_MMP 0x0100 231262723Spfg#define EXT2F_INCOMPAT_FLEX_BG 0x0200 232305494Spfg#define EXT2F_INCOMPAT_EA_INODE 0x0400 233305494Spfg#define EXT2F_INCOMPAT_DIRDATA 0x1000 234305494Spfg#define EXT2F_INCOMPAT_CSUM_SEED 0x2000 235305494Spfg#define EXT2F_INCOMPAT_LARGEDIR 0x4000 236305494Spfg#define EXT2F_INCOMPAT_INLINE_DATA 0x8000 237305494Spfg#define EXT2F_INCOMPAT_ENCRYPT 0x10000 238202283Slulf 239202283Slulf/* 240202283Slulf * Features supported in this implementation 241202283Slulf * 242202283Slulf * We support the following REV1 features: 243202283Slulf * - EXT2F_ROCOMPAT_SPARSESUPER 244202283Slulf * - EXT2F_ROCOMPAT_LARGEFILE 245262563Spfg * - EXT2F_ROCOMPAT_EXTRA_ISIZE 246202283Slulf * - EXT2F_INCOMPAT_FTYPE 247254260Spfg * 248262563Spfg * We partially support (read-only) the following EXT4 features: 249254260Spfg * - EXT2F_ROCOMPAT_HUGE_FILE 250254260Spfg * - EXT2F_INCOMPAT_EXTENTS 251262563Spfg * 252262563Spfg * We do not support these EXT4 features but they are irrelevant 253262563Spfg * for read-only support: 254293236Spfg * - EXT2F_INCOMPAT_RECOVER 255262563Spfg * - EXT2F_INCOMPAT_FLEX_BG 256262563Spfg * - EXT2F_INCOMPAT_META_BG 257202283Slulf */ 258296992Spfg#define EXT2F_COMPAT_SUPP EXT2F_COMPAT_DIRHASHINDEX 259262723Spfg#define EXT2F_ROCOMPAT_SUPP (EXT2F_ROCOMPAT_SPARSESUPER | \ 260232703Spfg EXT2F_ROCOMPAT_LARGEFILE | \ 261320839Spfg EXT2F_ROCOMPAT_HUGE_FILE | \ 262244475Spfg EXT2F_ROCOMPAT_EXTRA_ISIZE) 263262723Spfg#define EXT2F_INCOMPAT_SUPP EXT2F_INCOMPAT_FTYPE 264262723Spfg#define EXT4F_RO_INCOMPAT_SUPP (EXT2F_INCOMPAT_EXTENTS | \ 265293236Spfg EXT2F_INCOMPAT_RECOVER | \ 266262563Spfg EXT2F_INCOMPAT_FLEX_BG | \ 267262563Spfg EXT2F_INCOMPAT_META_BG ) 268202283Slulf 269218273Sjhb/* Assume that user mode programs are passing in an ext2fs superblock, not 270218273Sjhb * a kernel struct super_block. This will allow us to call the feature-test 271218273Sjhb * macros from user land. */ 272262723Spfg#define EXT2_SB(sb) (sb) 273218273Sjhb 274202283Slulf/* 275202283Slulf * Feature set definitions 276202283Slulf */ 277262723Spfg#define EXT2_HAS_COMPAT_FEATURE(sb,mask) \ 278202283Slulf ( EXT2_SB(sb)->e2fs->e2fs_features_compat & htole32(mask) ) 279262723Spfg#define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \ 280202283Slulf ( EXT2_SB(sb)->e2fs->e2fs_features_rocompat & htole32(mask) ) 281262723Spfg#define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \ 282202283Slulf ( EXT2_SB(sb)->e2fs->e2fs_features_incompat & htole32(mask) ) 283202283Slulf 284202283Slulf/* 285202283Slulf * File clean flags 286202283Slulf */ 287202283Slulf#define E2FS_ISCLEAN 0x0001 /* Unmounted cleanly */ 288202283Slulf#define E2FS_ERRORS 0x0002 /* Errors detected */ 289202283Slulf 290296992Spfg/* 291296992Spfg * Filesystem miscellaneous flags 292296992Spfg */ 293296992Spfg#define E2FS_SIGNED_HASH 0x0001 294296992Spfg#define E2FS_UNSIGNED_HASH 0x0002 295296992Spfg 296202283Slulf/* ext2 file system block group descriptor */ 297202283Slulf 298202283Slulfstruct ext2_gd { 299221126Sjhb uint32_t ext2bgd_b_bitmap; /* blocks bitmap block */ 300221126Sjhb uint32_t ext2bgd_i_bitmap; /* inodes bitmap block */ 301221126Sjhb uint32_t ext2bgd_i_tables; /* inodes table block */ 302221126Sjhb uint16_t ext2bgd_nbfree; /* number of free blocks */ 303221126Sjhb uint16_t ext2bgd_nifree; /* number of free inodes */ 304251336Spfg uint16_t ext2bgd_ndirs; /* number of directories */ 305252012Spfg uint16_t ext4bgd_flags; /* block group flags */ 306252012Spfg uint32_t ext4bgd_x_bitmap; /* snapshot exclusion bitmap loc. */ 307252012Spfg uint16_t ext4bgd_b_bmap_csum; /* block bitmap checksum */ 308252012Spfg uint16_t ext4bgd_i_bmap_csum; /* inode bitmap checksum */ 309252012Spfg uint16_t ext4bgd_i_unused; /* unused inode count */ 310252012Spfg uint16_t ext4bgd_csum; /* group descriptor checksum */ 311202283Slulf}; 312202283Slulf 313228539Spfg 314202283Slulf/* EXT2FS metadatas are stored in little-endian byte order. These macros 315202283Slulf * helps reading these metadatas 316202283Slulf */ 317202283Slulf 318262723Spfg#define e2fs_cgload(old, new, size) memcpy((new), (old), (size)); 319262723Spfg#define e2fs_cgsave(old, new, size) memcpy((new), (old), (size)); 320218273Sjhb 321202283Slulf/* 322202283Slulf * Macro-instructions used to manage several block sizes 323202283Slulf */ 324202283Slulf#define EXT2_MAX_BLOCK_SIZE 4096 325262723Spfg#define EXT2_MIN_BLOCK_LOG_SIZE 10 326262723Spfg#define EXT2_BLOCK_SIZE(s) ((s)->e2fs_bsize) 327228583Spfg#define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof(uint32_t)) 328262723Spfg#define EXT2_INODE_SIZE(s) (EXT2_SB(s)->e2fs_isize) 329202283Slulf 330202283Slulf/* 331202283Slulf * Macro-instructions used to manage fragments 332202283Slulf */ 333262723Spfg#define EXT2_MIN_FRAG_SIZE 1024 334202283Slulf#define EXT2_MAX_FRAG_SIZE 4096 335262723Spfg#define EXT2_MIN_FRAG_LOG_SIZE 10 336262723Spfg#define EXT2_FRAG_SIZE(s) (EXT2_SB(s)->e2fs_fsize) 337262723Spfg#define EXT2_FRAGS_PER_BLOCK(s) (EXT2_SB(s)->e2fs_fpb) 338202283Slulf 339202283Slulf/* 340202283Slulf * Macro-instructions used to manage group descriptors 341202283Slulf */ 342262723Spfg#define EXT2_BLOCKS_PER_GROUP(s) (EXT2_SB(s)->e2fs_bpg) 343202283Slulf 344218176Sjhb#endif /* !_FS_EXT2FS_EXT2FS_H_ */ 345