lib/ext2fs/ext2_fs.h

   1 /*
   2  *  linux/include/linux/ext2_fs.h
   3  *
   4  * Copyright (C) 1992, 1993, 1994, 1995
   5  * Remy Card (card@masi.ibp.fr)
   6  * Laboratoire MASI - Institut Blaise Pascal
   7  * Universite Pierre et Marie Curie (Paris VI)
   8  *
   9  *  from
  10  *
  11  *  linux/include/linux/minix_fs.h
  12  *
  13  *  Copyright (C) 1991, 1992  Linus Torvalds
  14  */
  15
  16 #ifndef _LINUX_EXT2_FS_H
  17 #define _LINUX_EXT2_FS_H
  18
  19 #include <ext2fs/ext2_types.h>          /* Changed from linux/types.h */
  20
  21 #ifndef __GNUC_PREREQ
  22 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
  23 #define __GNUC_PREREQ(maj, min) \
  24         ((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
  25 #else
  26 #define __GNUC_PREREQ(maj, min) 0
  27 #endif
  28 #endif
  29
  30 /*
  31  * The second extended filesystem constants/structures
  32  */
  33
  34 /*
  35  * Define EXT2FS_DEBUG to produce debug messages
  36  */
  37 #undef EXT2FS_DEBUG
  38
  39 /*
  40  * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
  41  */
  42 #define EXT2_PREALLOCATE
  43 #define EXT2_DEFAULT_PREALLOC_BLOCKS    8
  44
  45 /*
  46  * The second extended file system version
  47  */
  48 #define EXT2FS_DATE             "95/08/09"
  49 #define EXT2FS_VERSION          "0.5b"
  50
  51 /*
  52  * Special inode numbers
  53  */
  54 #define EXT2_BAD_INO             1      /* Bad blocks inode */
  55 #define EXT2_ROOT_INO            2      /* Root inode */
  56 #define EXT4_USR_QUOTA_INO       3      /* User quota inode */
  57 #define EXT4_GRP_QUOTA_INO       4      /* Group quota inode */
  58 #define EXT2_BOOT_LOADER_INO     5      /* Boot loader inode */
  59 #define EXT2_UNDEL_DIR_INO       6      /* Undelete directory inode */
  60 #define EXT2_RESIZE_INO          7      /* Reserved group descriptors inode */
  61 #define EXT2_JOURNAL_INO         8      /* Journal inode */
  62 #define EXT2_EXCLUDE_INO         9      /* The "exclude" inode, for snapshots */
  63 #define EXT4_REPLICA_INO        10      /* Used by non-upstream feature */
  64
  65 /* First non-reserved inode for old ext2 filesystems */
  66 #define EXT2_GOOD_OLD_FIRST_INO 11
  67
  68 /*
  69  * The second extended file system magic number
  70  */
  71 #define EXT2_SUPER_MAGIC        0xEF53
  72
  73 #ifdef __KERNEL__
  74 #define EXT2_SB(sb)     (&((sb)->u.ext2_sb))
  75 #else
  76 /* Assume that user mode programs are passing in an ext2fs superblock, not
  77  * a kernel struct super_block.  This will allow us to call the feature-test
  78  * macros from user land. */
  79 #define EXT2_SB(sb)     (sb)
  80 #endif
  81
  82 /*
  83  * Maximal count of links to a file
  84  */
  85 #define EXT2_LINK_MAX           65000
  86
  87 /*
  88  * Macro-instructions used to manage several block sizes
  89  */
  90 #define EXT2_MIN_BLOCK_LOG_SIZE         10      /* 1024 */
  91 #define EXT2_MAX_BLOCK_LOG_SIZE         16      /* 65536 */
  92 #define EXT2_MIN_BLOCK_SIZE     (1 << EXT2_MIN_BLOCK_LOG_SIZE)
  93 #define EXT2_MAX_BLOCK_SIZE     (1 << EXT2_MAX_BLOCK_LOG_SIZE)
  94 #ifdef __KERNEL__
  95 #define EXT2_BLOCK_SIZE(s)      ((s)->s_blocksize)
  96 #define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
  97 #define EXT2_ADDR_PER_BLOCK_BITS(s)     (EXT2_SB(s)->addr_per_block_bits)
  98 #define EXT2_INODE_SIZE(s)      (EXT2_SB(s)->s_inode_size)
  99 #define EXT2_FIRST_INO(s)       (EXT2_SB(s)->s_first_ino)
 100 #else
 101 #define EXT2_BLOCK_SIZE(s)      (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
 102 #define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
 103 #define EXT2_INODE_SIZE(s)      (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
 104                                  EXT2_GOOD_OLD_INODE_SIZE : (s)->s_inode_size)
 105 #define EXT2_FIRST_INO(s)       (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
 106                                  EXT2_GOOD_OLD_FIRST_INO : (s)->s_first_ino)
 107 #endif
 108 #define EXT2_ADDR_PER_BLOCK(s)  (EXT2_BLOCK_SIZE(s) / sizeof(__u32))
 109
 110 /*
 111  * Macro-instructions used to manage allocation clusters
 112  */
 113 #define EXT2_MIN_CLUSTER_LOG_SIZE       EXT2_MIN_BLOCK_LOG_SIZE
 114 #define EXT2_MAX_CLUSTER_LOG_SIZE       29      /* 512MB  */
 115 #define EXT2_MIN_CLUSTER_SIZE           EXT2_MIN_BLOCK_SIZE
 116 #define EXT2_MAX_CLUSTER_SIZE           (1 << EXT2_MAX_CLUSTER_LOG_SIZE)
 117 #define EXT2_CLUSTER_SIZE(s)            (EXT2_MIN_BLOCK_SIZE << \
 118                                                 (s)->s_log_cluster_size)
 119 #define EXT2_CLUSTER_SIZE_BITS(s)       ((s)->s_log_cluster_size + 10)
 120
 121 /*
 122  * Macro-instructions used to manage fragments
 123  *
 124  * Note: for backwards compatibility only, for the dump program.
 125  * Ext2/3/4 will never support fragments....
 126  */
 127 #define EXT2_MIN_FRAG_SIZE              EXT2_MIN_BLOCK_SIZE
 128 #define EXT2_MAX_FRAG_SIZE              EXT2_MAX_BLOCK_SIZE
 129 #define EXT2_MIN_FRAG_LOG_SIZE          EXT2_MIN_BLOCK_LOG_SIZE
 130 #define EXT2_FRAG_SIZE(s)               EXT2_BLOCK_SIZE(s)
 131 #define EXT2_FRAGS_PER_BLOCK(s)         1
 132
 133 /*
 134  * ACL structures
 135  */
 136 struct ext2_acl_header  /* Header of Access Control Lists */
 137 {
 138         __u32   aclh_size;
 139         __u32   aclh_file_count;
 140         __u32   aclh_acle_count;
 141         __u32   aclh_first_acle;
 142 };
 143
 144 struct ext2_acl_entry   /* Access Control List Entry */
 145 {
 146         __u32   acle_size;
 147         __u16   acle_perms;     /* Access permissions */
 148         __u16   acle_type;      /* Type of entry */
 149         __u16   acle_tag;       /* User or group identity */
 150         __u16   acle_pad1;
 151         __u32   acle_next;      /* Pointer on next entry for the */
 152                                         /* same inode or on next free entry */
 153 };
 154
 155 /*
 156  * Structure of a blocks group descriptor
 157  */
 158 struct ext2_group_desc
 159 {
 160         __u32   bg_block_bitmap;        /* Blocks bitmap block */
 161         __u32   bg_inode_bitmap;        /* Inodes bitmap block */
 162         __u32   bg_inode_table;         /* Inodes table block */
 163         __u16   bg_free_blocks_count;   /* Free blocks count */
 164         __u16   bg_free_inodes_count;   /* Free inodes count */
 165         __u16   bg_used_dirs_count;     /* Directories count */
 166         __u16   bg_flags;
 167         __u32   bg_exclude_bitmap_lo;   /* Exclude bitmap for snapshots */
 168         __u16   bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
 169         __u16   bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
 170         __u16   bg_itable_unused;       /* Unused inodes count */
 171         __u16   bg_checksum;            /* crc16(s_uuid+group_num+group_desc)*/
 172 };
 173
 174 /*
 175  * Structure of a blocks group descriptor
 176  */
 177 struct ext4_group_desc
 178 {
 179         __u32   bg_block_bitmap;        /* Blocks bitmap block */
 180         __u32   bg_inode_bitmap;        /* Inodes bitmap block */
 181         __u32   bg_inode_table;         /* Inodes table block */
 182         __u16   bg_free_blocks_count;   /* Free blocks count */
 183         __u16   bg_free_inodes_count;   /* Free inodes count */
 184         __u16   bg_used_dirs_count;     /* Directories count */
 185         __u16   bg_flags;               /* EXT4_BG_flags (INODE_UNINIT, etc) */
 186         __u32   bg_exclude_bitmap_lo;   /* Exclude bitmap for snapshots */
 187         __u16   bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
 188         __u16   bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
 189         __u16   bg_itable_unused;       /* Unused inodes count */
 190         __u16   bg_checksum;            /* crc16(sb_uuid+group+desc) */
 191         __u32   bg_block_bitmap_hi;     /* Blocks bitmap block MSB */
 192         __u32   bg_inode_bitmap_hi;     /* Inodes bitmap block MSB */
 193         __u32   bg_inode_table_hi;      /* Inodes table block MSB */
 194         __u16   bg_free_blocks_count_hi;/* Free blocks count MSB */
 195         __u16   bg_free_inodes_count_hi;/* Free inodes count MSB */
 196         __u16   bg_used_dirs_count_hi;  /* Directories count MSB */
 197         __u16   bg_itable_unused_hi;    /* Unused inodes count MSB */
 198         __u32   bg_exclude_bitmap_hi;   /* Exclude bitmap block MSB */
 199         __u16   bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
 200         __u16   bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
 201         __u32   bg_reserved;
 202 };
 203
 204 #define EXT4_BG_INODE_BITMAP_CSUM_HI_END        \
 205         (offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
 206          sizeof(__u16))
 207 #define EXT4_BG_BLOCK_BITMAP_CSUM_HI_LOCATION   \
 208         (offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
 209          sizeof(__u16))
 210
 211 #define EXT2_BG_INODE_UNINIT    0x0001 /* Inode table/bitmap not initialized */
 212 #define EXT2_BG_BLOCK_UNINIT    0x0002 /* Block bitmap not initialized */
 213 #define EXT2_BG_INODE_ZEROED    0x0004 /* On-disk itable initialized to zero */
 214
 215 /*
 216  * Data structures used by the directory indexing feature
 217  *
 218  * Note: all of the multibyte integer fields are little endian.
 219  */
 220
 221 /*
 222  * Note: dx_root_info is laid out so that if it should somehow get
 223  * overlaid by a dirent the two low bits of the hash version will be
 224  * zero.  Therefore, the hash version mod 4 should never be 0.
 225  * Sincerely, the paranoia department.
 226  */
 227 struct ext2_dx_root_info {
 228         __u32 reserved_zero;
 229         __u8 hash_version; /* 0 now, 1 at release */
 230         __u8 info_length; /* 8 */
 231         __u8 indirect_levels;
 232         __u8 unused_flags;
 233 };
 234
 235 #define EXT2_HASH_LEGACY                0
 236 #define EXT2_HASH_HALF_MD4              1
 237 #define EXT2_HASH_TEA                   2
 238 #define EXT2_HASH_LEGACY_UNSIGNED       3 /* reserved for userspace lib */
 239 #define EXT2_HASH_HALF_MD4_UNSIGNED     4 /* reserved for userspace lib */
 240 #define EXT2_HASH_TEA_UNSIGNED          5 /* reserved for userspace lib */
 241 #define EXT2_HASH_SIPHASH               6
 242
 243 #define EXT2_HASH_FLAG_INCOMPAT 0x1
 244
 245 #define EXT4_DX_BLOCK_MASK 0x0fffffff
 246
 247 struct ext2_dx_entry {
 248         __le32 hash;
 249         __le32 block;
 250 };
 251
 252 struct ext2_dx_countlimit {
 253         __le16 limit;
 254         __le16 count;
 255 };
 256
 257 /*
 258  * This goes at the end of each htree block.
 259  */
 260 struct ext2_dx_tail {
 261         __le32 dt_reserved;
 262         __le32 dt_checksum;     /* crc32c(uuid+inum+dxblock) */
 263 };
 264
 265 /*
 266  * Macro-instructions used to manage group descriptors
 267  */
 268 #define EXT2_MIN_DESC_SIZE             32
 269 #define EXT2_MIN_DESC_SIZE_64BIT       64
 270 #define EXT2_MAX_DESC_SIZE             EXT2_MIN_BLOCK_SIZE
 271 #define EXT2_DESC_SIZE(s)                                                \
 272         (ext2fs_has_feature_64bit(s) ? (s)->s_desc_size : EXT2_MIN_DESC_SIZE)
 273
 274 #define EXT2_BLOCKS_PER_GROUP(s)        (EXT2_SB(s)->s_blocks_per_group)
 275 #define EXT2_INODES_PER_GROUP(s)        (EXT2_SB(s)->s_inodes_per_group)
 276 #define EXT2_CLUSTERS_PER_GROUP(s)      (EXT2_SB(s)->s_clusters_per_group)
 277 #define EXT2_INODES_PER_BLOCK(s)        (EXT2_BLOCK_SIZE(s)/EXT2_INODE_SIZE(s))
 278 /* limits imposed by 16-bit value gd_free_{blocks,inode}_count */
 279 #define EXT2_MAX_BLOCKS_PER_GROUP(s)    ((((unsigned) 1 << 16) - 8) *   \
 280                                          (EXT2_CLUSTER_SIZE(s) / \
 281                                           EXT2_BLOCK_SIZE(s)))
 282 #define EXT2_MAX_CLUSTERS_PER_GROUP(s)  (((unsigned) 1 << 16) - 8)
 283 #define EXT2_MAX_INODES_PER_GROUP(s)    (((unsigned) 1 << 16) - \
 284                                          EXT2_INODES_PER_BLOCK(s))
 285 #ifdef __KERNEL__
 286 #define EXT2_DESC_PER_BLOCK(s)          (EXT2_SB(s)->s_desc_per_block)
 287 #define EXT2_DESC_PER_BLOCK_BITS(s)     (EXT2_SB(s)->s_desc_per_block_bits)
 288 #else
 289 #define EXT2_DESC_PER_BLOCK(s)          (EXT2_BLOCK_SIZE(s) / EXT2_DESC_SIZE(s))
 290 #endif
 291
 292 #define EXT2_GROUPS_TO_BLOCKS(s, g)   ((blk64_t) EXT2_BLOCKS_PER_GROUP(s) * \
 293                                        (g))
 294 #define EXT2_GROUPS_TO_CLUSTERS(s, g) ((blk64_t) EXT2_CLUSTERS_PER_GROUP(s) * \
 295                                        (g))
 296
 297 /*
 298  * Constants relative to the data blocks
 299  */
 300 #define EXT2_NDIR_BLOCKS                12
 301 #define EXT2_IND_BLOCK                  EXT2_NDIR_BLOCKS
 302 #define EXT2_DIND_BLOCK                 (EXT2_IND_BLOCK + 1)
 303 #define EXT2_TIND_BLOCK                 (EXT2_DIND_BLOCK + 1)
 304 #define EXT2_N_BLOCKS                   (EXT2_TIND_BLOCK + 1)
 305
 306 /*
 307  * Inode flags
 308  */
 309 #define EXT2_SECRM_FL                   0x00000001 /* Secure deletion */
 310 #define EXT2_UNRM_FL                    0x00000002 /* Undelete */
 311 #define EXT2_COMPR_FL                   0x00000004 /* Compress file */
 312 #define EXT2_SYNC_FL                    0x00000008 /* Synchronous updates */
 313 #define EXT2_IMMUTABLE_FL               0x00000010 /* Immutable file */
 314 #define EXT2_APPEND_FL                  0x00000020 /* writes to file may only append */
 315 #define EXT2_NODUMP_FL                  0x00000040 /* do not dump file */
 316 #define EXT2_NOATIME_FL                 0x00000080 /* do not update atime */
 317 /* Reserved for compression usage... */
 318 #define EXT2_DIRTY_FL                   0x00000100
 319 #define EXT2_COMPRBLK_FL                0x00000200 /* One or more compressed clusters */
 320 #define EXT2_NOCOMPR_FL                 0x00000400 /* Access raw compressed data */
 321         /* nb: was previously EXT2_ECOMPR_FL */
 322 #define EXT4_ENCRYPT_FL                 0x00000800 /* encrypted inode */
 323 /* End compression flags --- maybe not all used */
 324 #define EXT2_BTREE_FL                   0x00001000 /* btree format dir */
 325 #define EXT2_INDEX_FL                   0x00001000 /* hash-indexed directory */
 326 #define EXT2_IMAGIC_FL                  0x00002000
 327 #define EXT3_JOURNAL_DATA_FL            0x00004000 /* file data should be journaled */
 328 #define EXT2_NOTAIL_FL                  0x00008000 /* file tail should not be merged */
 329 #define EXT2_DIRSYNC_FL                 0x00010000 /* Synchronous directory modifications */
 330 #define EXT2_TOPDIR_FL                  0x00020000 /* Top of directory hierarchies*/
 331 #define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
 332 #define EXT4_EXTENTS_FL                 0x00080000 /* Inode uses extents */
 333 #define EXT4_VERITY_FL                  0x00100000 /* Verity protected inode */
 334 #define EXT4_EA_INODE_FL                0x00200000 /* Inode used for large EA */
 335 /* EXT4_EOFBLOCKS_FL 0x00400000 was here */
 336 #define FS_NOCOW_FL                     0x00800000 /* Do not cow file */
 337 #define EXT4_SNAPFILE_FL                0x01000000  /* Inode is a snapshot */
 338 #define FS_DAX_FL                       0x02000000 /* Inode is DAX */
 339 #define EXT4_SNAPFILE_DELETED_FL        0x04000000  /* Snapshot is being deleted */
 340 #define EXT4_SNAPFILE_SHRUNK_FL         0x08000000  /* Snapshot shrink has completed */
 341 #define EXT4_INLINE_DATA_FL             0x10000000 /* Inode has inline data */
 342 #define EXT4_PROJINHERIT_FL             0x20000000 /* Create with parents projid */
 343 #define EXT4_CASEFOLD_FL                0x40000000 /* Casefolded file */
 344 #define EXT2_RESERVED_FL                0x80000000 /* reserved for ext2 lib */
 345
 346 #define EXT2_FL_USER_VISIBLE            0x604BDFFF /* User visible flags */
 347 #define EXT2_FL_USER_MODIFIABLE         0x604B80FF /* User modifiable flags */
 348
 349 /*
 350  * ioctl commands
 351  */
 352
 353 /* Used for online resize */
 354 struct ext2_new_group_input {
 355         __u32 group;            /* Group number for this data */
 356         __u32 block_bitmap;     /* Absolute block number of block bitmap */
 357         __u32 inode_bitmap;     /* Absolute block number of inode bitmap */
 358         __u32 inode_table;      /* Absolute block number of inode table start */
 359         __u32 blocks_count;     /* Total number of blocks in this group */
 360         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
 361         __u16 unused;           /* Number of reserved GDT blocks in group */
 362 };
 363
 364 struct ext4_new_group_input {
 365         __u32 group;            /* Group number for this data */
 366         __u64 block_bitmap;     /* Absolute block number of block bitmap */
 367         __u64 inode_bitmap;     /* Absolute block number of inode bitmap */
 368         __u64 inode_table;      /* Absolute block number of inode table start */
 369         __u32 blocks_count;     /* Total number of blocks in this group */
 370         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
 371         __u16 unused;
 372 };
 373
 374 #ifdef __GNU__                  /* Needed for the Hurd */
 375 #define _IOT_ext2_new_group_input _IOT (_IOTS(__u32), 5, _IOTS(__u16), 2, 0, 0)
 376 #endif
 377
 378 #define EXT2_IOC_GETFLAGS               _IOR('f', 1, long)
 379 #define EXT2_IOC_SETFLAGS               _IOW('f', 2, long)
 380 #define EXT2_IOC_GETVERSION             _IOR('v', 1, long)
 381 #define EXT2_IOC_SETVERSION             _IOW('v', 2, long)
 382 #define EXT2_IOC_GETVERSION_NEW         _IOR('f', 3, long)
 383 #define EXT2_IOC_SETVERSION_NEW         _IOW('f', 4, long)
 384 #define EXT2_IOC_GROUP_EXTEND           _IOW('f', 7, unsigned long)
 385 #define EXT2_IOC_GROUP_ADD              _IOW('f', 8,struct ext2_new_group_input)
 386 #define EXT4_IOC_GROUP_ADD              _IOW('f', 8,struct ext4_new_group_input)
 387 #define EXT4_IOC_RESIZE_FS              _IOW('f', 16, __u64)
 388
 389 /*
 390  * Structure of an inode on the disk
 391  */
 392 struct ext2_inode {
 393 /*00*/  __u16   i_mode;         /* File mode */
 394         __u16   i_uid;          /* Low 16 bits of Owner Uid */
 395         __u32   i_size;         /* Size in bytes */
 396         __u32   i_atime;        /* Access time */
 397         __u32   i_ctime;        /* Inode change time */
 398 /*10*/  __u32   i_mtime;        /* Modification time */
 399         __u32   i_dtime;        /* Deletion Time */
 400         __u16   i_gid;          /* Low 16 bits of Group Id */
 401         __u16   i_links_count;  /* Links count */
 402         __u32   i_blocks;       /* Blocks count */
 403 /*20*/  __u32   i_flags;        /* File flags */
 404         union {
 405                 struct {
 406                         __u32   l_i_version; /* was l_i_reserved1 */
 407                 } linux1;
 408                 struct {
 409                         __u32  h_i_translator;
 410                 } hurd1;
 411         } osd1;                         /* OS dependent 1 */
 412 /*28*/  __u32   i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
 413 /*64*/  __u32   i_generation;   /* File version (for NFS) */
 414         __u32   i_file_acl;     /* File ACL */
 415         __u32   i_size_high;
 416 /*70*/  __u32   i_faddr;        /* Fragment address */
 417         union {
 418                 struct {
 419                         __u16   l_i_blocks_hi;
 420                         __u16   l_i_file_acl_high;
 421                         __u16   l_i_uid_high;   /* these 2 fields    */
 422                         __u16   l_i_gid_high;   /* were reserved2[0] */
 423                         __u16   l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
 424                         __u16   l_i_reserved;
 425                 } linux2;
 426                 struct {
 427                         __u8    h_i_frag;       /* Fragment number */
 428                         __u8    h_i_fsize;      /* Fragment size */
 429                         __u16   h_i_mode_high;
 430                         __u16   h_i_uid_high;
 431                         __u16   h_i_gid_high;
 432                         __u32   h_i_author;
 433                 } hurd2;
 434         } osd2;                         /* OS dependent 2 */
 435 };
 436
 437 /*
 438  * Permanent part of an large inode on the disk
 439  */
 440 struct ext2_inode_large {
 441 /*00*/  __u16   i_mode;         /* File mode */
 442         __u16   i_uid;          /* Low 16 bits of Owner Uid */
 443         __u32   i_size;         /* Size in bytes */
 444         __u32   i_atime;        /* Access time */
 445         __u32   i_ctime;        /* Inode Change time */
 446 /*10*/  __u32   i_mtime;        /* Modification time */
 447         __u32   i_dtime;        /* Deletion Time */
 448         __u16   i_gid;          /* Low 16 bits of Group Id */
 449         __u16   i_links_count;  /* Links count */
 450         __u32   i_blocks;       /* Blocks count */
 451 /*20*/  __u32   i_flags;        /* File flags */
 452         union {
 453                 struct {
 454                         __u32   l_i_version; /* was l_i_reserved1 */
 455                 } linux1;
 456                 struct {
 457                         __u32  h_i_translator;
 458                 } hurd1;
 459         } osd1;                         /* OS dependent 1 */
 460 /*28*/  __u32   i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
 461 /*64*/  __u32   i_generation;   /* File version (for NFS) */
 462         __u32   i_file_acl;     /* File ACL */
 463         __u32   i_size_high;
 464 /*70*/  __u32   i_faddr;        /* Fragment address */
 465         union {
 466                 struct {
 467                         __u16   l_i_blocks_hi;
 468                         __u16   l_i_file_acl_high;
 469                         __u16   l_i_uid_high;   /* these 2 fields    */
 470                         __u16   l_i_gid_high;   /* were reserved2[0] */
 471                         __u16   l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
 472                         __u16   l_i_reserved;
 473                 } linux2;
 474                 struct {
 475                         __u8    h_i_frag;       /* Fragment number */
 476                         __u8    h_i_fsize;      /* Fragment size */
 477                         __u16   h_i_mode_high;
 478                         __u16   h_i_uid_high;
 479                         __u16   h_i_gid_high;
 480                         __u32   h_i_author;
 481                 } hurd2;
 482         } osd2;                         /* OS dependent 2 */
 483 /*80*/  __u16   i_extra_isize;
 484         __u16   i_checksum_hi;  /* crc32c(uuid+inum+inode) */
 485         __u32   i_ctime_extra;  /* extra Change time (nsec << 2 | epoch) */
 486         __u32   i_mtime_extra;  /* extra Modification time (nsec << 2 | epoch) */
 487         __u32   i_atime_extra;  /* extra Access time (nsec << 2 | epoch) */
 488 /*90*/  __u32   i_crtime;       /* File creation time */
 489         __u32   i_crtime_extra; /* extra File creation time (nsec << 2 | epoch)*/
 490         __u32   i_version_hi;   /* high 32 bits for 64-bit version */
 491 /*9c*/  __u32   i_projid;       /* Project ID */
 492 };
 493
 494 #define EXT4_INODE_CSUM_HI_EXTRA_END    \
 495         (offsetof(struct ext2_inode_large, i_checksum_hi) + sizeof(__u16) - \
 496          EXT2_GOOD_OLD_INODE_SIZE)
 497
 498 #define EXT4_EPOCH_BITS 2
 499 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
 500
 501 #define i_checksum_lo   osd2.linux2.l_i_checksum_lo
 502
 503 #define inode_includes(size, field)                     \
 504        (size >= (sizeof(((struct ext2_inode_large *)0)->field) + \
 505                  offsetof(struct ext2_inode_large, field)))
 506
 507 #define EXT2_FITS_IN_INODE(inode, field)              \
 508         ((offsetof(struct ext2_inode_large, field) +    \
 509          sizeof((inode)->field)) <=                  \
 510                          (EXT2_GOOD_OLD_INODE_SIZE +    \
 511                           (inode)->i_extra_isize))      \
 512
 513 #if defined(__KERNEL__) || defined(__linux__)
 514 #define i_reserved1     osd1.linux1.l_i_reserved1
 515 #define i_frag          osd2.linux2.l_i_frag
 516 #define i_fsize         osd2.linux2.l_i_fsize
 517 #define i_uid_low       i_uid
 518 #define i_gid_low       i_gid
 519 #define i_uid_high      osd2.linux2.l_i_uid_high
 520 #define i_gid_high      osd2.linux2.l_i_gid_high
 521 #else
 522 #if defined(__GNU__)
 523
 524 #define i_translator    osd1.hurd1.h_i_translator
 525 #define i_frag          osd2.hurd2.h_i_frag;
 526 #define i_fsize         osd2.hurd2.h_i_fsize;
 527 #define i_uid_high      osd2.hurd2.h_i_uid_high
 528 #define i_gid_high      osd2.hurd2.h_i_gid_high
 529 #define i_author        osd2.hurd2.h_i_author
 530
 531 #endif  /* __GNU__ */
 532 #endif  /* defined(__KERNEL__) || defined(__linux__) */
 533
 534 #define inode_uid(inode)        ((inode).i_uid | (inode).osd2.linux2.l_i_uid_high << 16)
 535 #define inode_gid(inode)        ((inode).i_gid | (inode).osd2.linux2.l_i_gid_high << 16)
 536 #define inode_projid(inode)     ((inode).i_projid)
 537 #define ext2fs_set_i_uid_high(inode,x) ((inode).osd2.linux2.l_i_uid_high = (x))
 538 #define ext2fs_set_i_gid_high(inode,x) ((inode).osd2.linux2.l_i_gid_high = (x))
 539
 540 static inline
 541 struct ext2_inode *EXT2_INODE(struct ext2_inode_large *large_inode)
 542 {
 543         return (struct ext2_inode *) large_inode;
 544 }
 545
 546 /*
 547  * File system states
 548  */
 549 #define EXT2_VALID_FS                   0x0001  /* Unmounted cleanly */
 550 #define EXT2_ERROR_FS                   0x0002  /* Errors detected */
 551 #define EXT3_ORPHAN_FS                  0x0004  /* Orphans being recovered */
 552 #define EXT4_FC_REPLAY                  0x0020  /* Ext4 fast commit replay ongoing */
 553
 554 /*
 555  * Misc. filesystem flags
 556  */
 557 #define EXT2_FLAGS_SIGNED_HASH          0x0001  /* Signed dirhash in use */
 558 #define EXT2_FLAGS_UNSIGNED_HASH        0x0002  /* Unsigned dirhash in use */
 559 #define EXT2_FLAGS_TEST_FILESYS         0x0004  /* OK for use on development code */
 560 #define EXT2_FLAGS_IS_SNAPSHOT          0x0010  /* This is a snapshot image */
 561 #define EXT2_FLAGS_FIX_SNAPSHOT         0x0020  /* Snapshot inodes corrupted */
 562 #define EXT2_FLAGS_FIX_EXCLUDE          0x0040  /* Exclude bitmaps corrupted */
 563
 564 /*
 565  * Mount flags
 566  */
 567 #define EXT2_MOUNT_CHECK                0x0001  /* Do mount-time checks */
 568 #define EXT2_MOUNT_GRPID                0x0004  /* Create files with directory's group */
 569 #define EXT2_MOUNT_DEBUG                0x0008  /* Some debugging messages */
 570 #define EXT2_MOUNT_ERRORS_CONT          0x0010  /* Continue on errors */
 571 #define EXT2_MOUNT_ERRORS_RO            0x0020  /* Remount fs ro on errors */
 572 #define EXT2_MOUNT_ERRORS_PANIC         0x0040  /* Panic on errors */
 573 #define EXT2_MOUNT_MINIX_DF             0x0080  /* Mimics the Minix statfs */
 574 #define EXT2_MOUNT_NO_UID32             0x0200  /* Disable 32-bit UIDs */
 575
 576 #define clear_opt(o, opt)               o &= ~EXT2_MOUNT_##opt
 577 #define set_opt(o, opt)                 o |= EXT2_MOUNT_##opt
 578 #define test_opt(sb, opt)               (EXT2_SB(sb)->s_mount_opt & \
 579                                          EXT2_MOUNT_##opt)
 580 /*
 581  * Maximal mount counts between two filesystem checks
 582  */
 583 #define EXT2_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
 584 #define EXT2_DFL_CHECKINTERVAL          0       /* Don't use interval check */
 585
 586 /*
 587  * Behaviour when detecting errors
 588  */
 589 #define EXT2_ERRORS_CONTINUE            1       /* Continue execution */
 590 #define EXT2_ERRORS_RO                  2       /* Remount fs read-only */
 591 #define EXT2_ERRORS_PANIC               3       /* Panic */
 592 #define EXT2_ERRORS_DEFAULT             EXT2_ERRORS_CONTINUE
 593
 594 #if (__GNUC__ >= 4)
 595 #define ext4_offsetof(TYPE,MEMBER) __builtin_offsetof(TYPE,MEMBER)
 596 #else
 597 #define ext4_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
 598 #endif
 599
 600 /* Metadata checksum algorithms */
 601 #define EXT2_CRC32C_CHKSUM              1
 602
 603 /* Encryption algorithms, key size and key reference len */
 604 #define EXT4_ENCRYPTION_MODE_INVALID            0
 605 #define EXT4_ENCRYPTION_MODE_AES_256_XTS        1
 606 #define EXT4_ENCRYPTION_MODE_AES_256_GCM        2
 607 #define EXT4_ENCRYPTION_MODE_AES_256_CBC        3
 608 #define EXT4_ENCRYPTION_MODE_AES_256_CTS        4
 609
 610 #define EXT4_AES_256_XTS_KEY_SIZE               64
 611 #define EXT4_AES_256_GCM_KEY_SIZE               32
 612 #define EXT4_AES_256_CBC_KEY_SIZE               32
 613 #define EXT4_AES_256_CTS_KEY_SIZE               32
 614 #define EXT4_MAX_KEY_SIZE                       64
 615
 616 #define EXT4_KEY_DESCRIPTOR_SIZE                8
 617 #define EXT4_CRYPTO_BLOCK_SIZE                  16
 618
 619 /* Password derivation constants */
 620 #define EXT4_MAX_PASSPHRASE_SIZE                1024
 621 #define EXT4_MAX_SALT_SIZE                      256
 622 #define EXT4_PBKDF2_ITERATIONS                  0xFFFF
 623
 624 #define EXT2_LABEL_LEN                          16
 625
 626 /*
 627  * Policy provided via an ioctl on the topmost directory. This
 628  * structure is also in the kernel.
 629  */
 630 struct ext4_encryption_policy {
 631   char version;
 632   char contents_encryption_mode;
 633   char filenames_encryption_mode;
 634   char flags;
 635   char master_key_descriptor[EXT4_KEY_DESCRIPTOR_SIZE];
 636 } __attribute__((__packed__));
 637
 638 struct ext4_encryption_key {
 639         __u32 mode;
 640         char raw[EXT4_MAX_KEY_SIZE];
 641         __u32 size;
 642 } __attribute__((__packed__));
 643
 644 /*
 645  * Structure of the super block
 646  */
 647 struct ext2_super_block {
 648 /*000*/ __u32   s_inodes_count;         /* Inodes count */
 649         __u32   s_blocks_count;         /* Blocks count */
 650         __u32   s_r_blocks_count;       /* Reserved blocks count */
 651         __u32   s_free_blocks_count;    /* Free blocks count */
 652 /*010*/ __u32   s_free_inodes_count;    /* Free inodes count */
 653         __u32   s_first_data_block;     /* First Data Block */
 654         __u32   s_log_block_size;       /* Block size */
 655         __u32   s_log_cluster_size;     /* Allocation cluster size */
 656 /*020*/ __u32   s_blocks_per_group;     /* # Blocks per group */
 657         __u32   s_clusters_per_group;   /* # Fragments per group */
 658         __u32   s_inodes_per_group;     /* # Inodes per group */
 659         __u32   s_mtime;                /* Mount time */
 660 /*030*/ __u32   s_wtime;                /* Write time */
 661         __u16   s_mnt_count;            /* Mount count */
 662         __s16   s_max_mnt_count;        /* Maximal mount count */
 663         __u16   s_magic;                /* Magic signature */
 664         __u16   s_state;                /* File system state */
 665         __u16   s_errors;               /* Behaviour when detecting errors */
 666         __u16   s_minor_rev_level;      /* minor revision level */
 667 /*040*/ __u32   s_lastcheck;            /* time of last check */
 668         __u32   s_checkinterval;        /* max. time between checks */
 669         __u32   s_creator_os;           /* OS */
 670         __u32   s_rev_level;            /* Revision level */
 671 /*050*/ __u16   s_def_resuid;           /* Default uid for reserved blocks */
 672         __u16   s_def_resgid;           /* Default gid for reserved blocks */
 673         /*
 674          * These fields are for EXT2_DYNAMIC_REV superblocks only.
 675          *
 676          * Note: the difference between the compatible feature set and
 677          * the incompatible feature set is that if there is a bit set
 678          * in the incompatible feature set that the kernel doesn't
 679          * know about, it should refuse to mount the filesystem.
 680          *
 681          * e2fsck's requirements are more strict; if it doesn't know
 682          * about a feature in either the compatible or incompatible
 683          * feature set, it must abort and not try to meddle with
 684          * things it doesn't understand...
 685          */
 686         __u32   s_first_ino;            /* First non-reserved inode */
 687         __u16   s_inode_size;           /* size of inode structure */
 688         __u16   s_block_group_nr;       /* block group # of this superblock */
 689         __u32   s_feature_compat;       /* compatible feature set */
 690 /*060*/ __u32   s_feature_incompat;     /* incompatible feature set */
 691         __u32   s_feature_ro_compat;    /* readonly-compatible feature set */
 692 /*068*/ __u8    s_uuid[16];             /* 128-bit uuid for volume */
 693 /*078*/ __u8    s_volume_name[EXT2_LABEL_LEN];  /* volume name, no NUL? */
 694 /*088*/ __u8    s_last_mounted[64];     /* directory last mounted on, no NUL? */
 695 /*0c8*/ __u32   s_algorithm_usage_bitmap; /* For compression */
 696         /*
 697          * Performance hints.  Directory preallocation should only
 698          * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
 699          */
 700         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
 701         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
 702         __u16   s_reserved_gdt_blocks;  /* Per group table for online growth */
 703         /*
 704          * Journaling support valid if EXT2_FEATURE_COMPAT_HAS_JOURNAL set.
 705          */
 706 /*0d0*/ __u8    s_journal_uuid[16];     /* uuid of journal superblock */
 707 /*0e0*/ __u32   s_journal_inum;         /* inode number of journal file */
 708         __u32   s_journal_dev;          /* device number of journal file */
 709         __u32   s_last_orphan;          /* start of list of inodes to delete */
 710 /*0ec*/ __u32   s_hash_seed[4];         /* HTREE hash seed */
 711 /*0fc*/ __u8    s_def_hash_version;     /* Default hash version to use */
 712         __u8    s_jnl_backup_type;      /* Default type of journal backup */
 713         __u16   s_desc_size;            /* Group desc. size: INCOMPAT_64BIT */
 714 /*100*/ __u32   s_default_mount_opts;   /* default EXT2_MOUNT_* flags used */
 715         __u32   s_first_meta_bg;        /* First metablock group */
 716         __u32   s_mkfs_time;            /* When the filesystem was created */
 717 /*10c*/ __u32   s_jnl_blocks[17];       /* Backup of the journal inode */
 718 /*150*/ __u32   s_blocks_count_hi;      /* Blocks count high 32bits */
 719         __u32   s_r_blocks_count_hi;    /* Reserved blocks count high 32 bits*/
 720         __u32   s_free_blocks_hi;       /* Free blocks count */
 721         __u16   s_min_extra_isize;      /* All inodes have at least # bytes */
 722         __u16   s_want_extra_isize;     /* New inodes should reserve # bytes */
 723 /*160*/ __u32   s_flags;                /* Miscellaneous flags */
 724         __u16   s_raid_stride;          /* RAID stride in blocks */
 725         __u16   s_mmp_update_interval;  /* # seconds to wait in MMP checking */
 726         __u64   s_mmp_block;            /* Block for multi-mount protection */
 727 /*170*/ __u32   s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
 728         __u8    s_log_groups_per_flex;  /* FLEX_BG group size */
 729         __u8    s_checksum_type;        /* metadata checksum algorithm */
 730         __u8    s_encryption_level;     /* versioning level for encryption */
 731         __u8    s_reserved_pad;         /* Padding to next 32bits */
 732         __u64   s_kbytes_written;       /* nr of lifetime kilobytes written */
 733 /*180*/ __u32   s_snapshot_inum;        /* Inode number of active snapshot */
 734         __u32   s_snapshot_id;          /* sequential ID of active snapshot */
 735         __u64   s_snapshot_r_blocks_count; /* active snapshot reserved blocks */
 736 /*190*/ __u32   s_snapshot_list;        /* inode number of disk snapshot list */
 737 #define EXT4_S_ERR_START ext4_offsetof(struct ext2_super_block, s_error_count)
 738         __u32   s_error_count;          /* number of fs errors */
 739         __u32   s_first_error_time;     /* first time an error happened */
 740         __u32   s_first_error_ino;      /* inode involved in first error */
 741 /*1a0*/ __u64   s_first_error_block;    /* block involved in first error */
 742         __u8    s_first_error_func[32]; /* function where error hit, no NUL? */
 743 /*1c8*/ __u32   s_first_error_line;     /* line number where error happened */
 744         __u32   s_last_error_time;      /* most recent time of an error */
 745 /*1d0*/ __u32   s_last_error_ino;       /* inode involved in last error */
 746         __u32   s_last_error_line;      /* line number where error happened */
 747         __u64   s_last_error_block;     /* block involved of last error */
 748 /*1e0*/ __u8    s_last_error_func[32];  /* function where error hit, no NUL? */
 749 #define EXT4_S_ERR_END ext4_offsetof(struct ext2_super_block, s_mount_opts)
 750 /*200*/ __u8    s_mount_opts[64];       /* default mount options, no NUL? */
 751 /*240*/ __u32   s_usr_quota_inum;       /* inode number of user quota file */
 752         __u32   s_grp_quota_inum;       /* inode number of group quota file */
 753         __u32   s_overhead_clusters;    /* overhead blocks/clusters in fs */
 754 /*24c*/ __u32   s_backup_bgs[2];        /* If sparse_super2 enabled */
 755 /*254*/ __u8    s_encrypt_algos[4];     /* Encryption algorithms in use  */
 756 /*258*/ __u8    s_encrypt_pw_salt[16];  /* Salt used for string2key algorithm */
 757 /*268*/ __le32  s_lpf_ino;              /* Location of the lost+found inode */
 758         __le32  s_prj_quota_inum;       /* inode for tracking project quota */
 759 /*270*/ __le32  s_checksum_seed;        /* crc32c(orig_uuid) if csum_seed set */
 760 /*274*/ __u8    s_wtime_hi;
 761         __u8    s_mtime_hi;
 762         __u8    s_mkfs_time_hi;
 763         __u8    s_lastcheck_hi;
 764         __u8    s_first_error_time_hi;
 765         __u8    s_last_error_time_hi;
 766         __u8    s_first_error_errcode;
 767         __u8    s_last_error_errcode;
 768 /*27c*/ __le16  s_encoding;             /* Filename charset encoding */
 769         __le16  s_encoding_flags;       /* Filename charset encoding flags */
 770         __le32  s_reserved[95];         /* Padding to the end of the block */
 771 /*3fc*/ __u32   s_checksum;             /* crc32c(superblock) */
 772 };
 773
 774 #define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
 775 #define EXT2_LEN_STR(buf) (int)sizeof(buf), (char *)buf
 776
 777 /*
 778  * Codes for operating systems
 779  */
 780 #define EXT2_OS_LINUX           0
 781 #define EXT2_OS_HURD            1
 782 #define EXT2_OBSO_OS_MASIX      2
 783 #define EXT2_OS_FREEBSD         3
 784 #define EXT2_OS_LITES           4
 785
 786 /*
 787  * Revision levels
 788  */
 789 #define EXT2_GOOD_OLD_REV       0       /* The good old (original) format */
 790 #define EXT2_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
 791
 792 #define EXT2_CURRENT_REV        EXT2_GOOD_OLD_REV
 793 #define EXT2_MAX_SUPP_REV       EXT2_DYNAMIC_REV
 794
 795 #define EXT2_GOOD_OLD_INODE_SIZE 128
 796
 797 /*
 798  * Journal inode backup types
 799  */
 800 #define EXT3_JNL_BACKUP_BLOCKS  1
 801
 802 /*
 803  * Feature set definitions
 804  */
 805
 806 #define EXT2_HAS_COMPAT_FEATURE(sb,mask)                        \
 807         ( EXT2_SB(sb)->s_feature_compat & (mask) )
 808 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask)                     \
 809         ( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
 810 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask)                      \
 811         ( EXT2_SB(sb)->s_feature_incompat & (mask) )
 812
 813 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC        0x0001
 814 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES       0x0002
 815 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL         0x0004
 816 #define EXT2_FEATURE_COMPAT_EXT_ATTR            0x0008
 817 #define EXT2_FEATURE_COMPAT_RESIZE_INODE        0x0010
 818 #define EXT2_FEATURE_COMPAT_DIR_INDEX           0x0020
 819 #define EXT2_FEATURE_COMPAT_LAZY_BG             0x0040
 820 /* #define EXT2_FEATURE_COMPAT_EXCLUDE_INODE    0x0080 not used, legacy */
 821 #define EXT2_FEATURE_COMPAT_EXCLUDE_BITMAP      0x0100
 822 #define EXT4_FEATURE_COMPAT_SPARSE_SUPER2       0x0200
 823 #define EXT4_FEATURE_COMPAT_FAST_COMMIT         0x0400
 824 #define EXT4_FEATURE_COMPAT_STABLE_INODES       0x0800
 825
 826
 827 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
 828 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
 829 /* #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR     0x0004 not used */
 830 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
 831 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM         0x0010
 832 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK        0x0020
 833 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE      0x0040
 834 #define EXT4_FEATURE_RO_COMPAT_HAS_SNAPSHOT     0x0080
 835 #define EXT4_FEATURE_RO_COMPAT_QUOTA            0x0100
 836 #define EXT4_FEATURE_RO_COMPAT_BIGALLOC         0x0200
 837 /*
 838  * METADATA_CSUM implies GDT_CSUM.  When METADATA_CSUM is set, group
 839  * descriptor checksums use the same algorithm as all other data
 840  * structures' checksums.
 841  */
 842 #define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM    0x0400
 843 #define EXT4_FEATURE_RO_COMPAT_REPLICA          0x0800
 844 #define EXT4_FEATURE_RO_COMPAT_READONLY         0x1000
 845 #define EXT4_FEATURE_RO_COMPAT_PROJECT          0x2000 /* Project quota */
 846 #define EXT4_FEATURE_RO_COMPAT_SHARED_BLOCKS    0x4000
 847 #define EXT4_FEATURE_RO_COMPAT_VERITY           0x8000
 848
 849 #define EXT2_FEATURE_INCOMPAT_COMPRESSION       0x0001
 850 #define EXT2_FEATURE_INCOMPAT_FILETYPE          0x0002
 851 #define EXT3_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
 852 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
 853 #define EXT2_FEATURE_INCOMPAT_META_BG           0x0010
 854 #define EXT3_FEATURE_INCOMPAT_EXTENTS           0x0040
 855 #define EXT4_FEATURE_INCOMPAT_64BIT             0x0080
 856 #define EXT4_FEATURE_INCOMPAT_MMP               0x0100
 857 #define EXT4_FEATURE_INCOMPAT_FLEX_BG           0x0200
 858 #define EXT4_FEATURE_INCOMPAT_EA_INODE          0x0400
 859 #define EXT4_FEATURE_INCOMPAT_DIRDATA           0x1000
 860 #define EXT4_FEATURE_INCOMPAT_CSUM_SEED         0x2000
 861 #define EXT4_FEATURE_INCOMPAT_LARGEDIR          0x4000 /* >2GB or 3-lvl htree */
 862 #define EXT4_FEATURE_INCOMPAT_INLINE_DATA       0x8000 /* data in inode */
 863 #define EXT4_FEATURE_INCOMPAT_ENCRYPT           0x10000
 864 #define EXT4_FEATURE_INCOMPAT_CASEFOLD          0x20000
 865
 866 #define EXT4_FEATURE_COMPAT_FUNCS(name, ver, flagname) \
 867 static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
 868 { \
 869         return ((EXT2_SB(sb)->s_feature_compat & \
 870                  EXT##ver##_FEATURE_COMPAT_##flagname) != 0); \
 871 } \
 872 static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
 873 { \
 874         EXT2_SB(sb)->s_feature_compat |= \
 875                 EXT##ver##_FEATURE_COMPAT_##flagname; \
 876 } \
 877 static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
 878 { \
 879         EXT2_SB(sb)->s_feature_compat &= \
 880                 ~EXT##ver##_FEATURE_COMPAT_##flagname; \
 881 }
 882
 883 #define EXT4_FEATURE_RO_COMPAT_FUNCS(name, ver, flagname) \
 884 static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
 885 { \
 886         return ((EXT2_SB(sb)->s_feature_ro_compat & \
 887                  EXT##ver##_FEATURE_RO_COMPAT_##flagname) != 0); \
 888 } \
 889 static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
 890 { \
 891         EXT2_SB(sb)->s_feature_ro_compat |= \
 892                 EXT##ver##_FEATURE_RO_COMPAT_##flagname; \
 893 } \
 894 static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
 895 { \
 896         EXT2_SB(sb)->s_feature_ro_compat &= \
 897                 ~EXT##ver##_FEATURE_RO_COMPAT_##flagname; \
 898 }
 899
 900 #define EXT4_FEATURE_INCOMPAT_FUNCS(name, ver, flagname) \
 901 static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
 902 { \
 903         return ((EXT2_SB(sb)->s_feature_incompat & \
 904                  EXT##ver##_FEATURE_INCOMPAT_##flagname) != 0); \
 905 } \
 906 static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
 907 { \
 908         EXT2_SB(sb)->s_feature_incompat |= \
 909                 EXT##ver##_FEATURE_INCOMPAT_##flagname; \
 910 } \
 911 static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
 912 { \
 913         EXT2_SB(sb)->s_feature_incompat &= \
 914                 ~EXT##ver##_FEATURE_INCOMPAT_##flagname; \
 915 }
 916
 917 EXT4_FEATURE_COMPAT_FUNCS(dir_prealloc,         2, DIR_PREALLOC)
 918 EXT4_FEATURE_COMPAT_FUNCS(imagic_inodes,        2, IMAGIC_INODES)
 919 EXT4_FEATURE_COMPAT_FUNCS(journal,              3, HAS_JOURNAL)
 920 EXT4_FEATURE_COMPAT_FUNCS(xattr,                2, EXT_ATTR)
 921 EXT4_FEATURE_COMPAT_FUNCS(resize_inode,         2, RESIZE_INODE)
 922 EXT4_FEATURE_COMPAT_FUNCS(dir_index,            2, DIR_INDEX)
 923 EXT4_FEATURE_COMPAT_FUNCS(lazy_bg,              2, LAZY_BG)
 924 EXT4_FEATURE_COMPAT_FUNCS(exclude_bitmap,       2, EXCLUDE_BITMAP)
 925 EXT4_FEATURE_COMPAT_FUNCS(sparse_super2,        4, SPARSE_SUPER2)
 926 EXT4_FEATURE_COMPAT_FUNCS(fast_commit,          4, FAST_COMMIT)
 927 EXT4_FEATURE_COMPAT_FUNCS(stable_inodes,        4, STABLE_INODES)
 928
 929 EXT4_FEATURE_RO_COMPAT_FUNCS(sparse_super,      2, SPARSE_SUPER)
 930 EXT4_FEATURE_RO_COMPAT_FUNCS(large_file,        2, LARGE_FILE)
 931 EXT4_FEATURE_RO_COMPAT_FUNCS(huge_file,         4, HUGE_FILE)
 932 EXT4_FEATURE_RO_COMPAT_FUNCS(gdt_csum,          4, GDT_CSUM)
 933 EXT4_FEATURE_RO_COMPAT_FUNCS(dir_nlink,         4, DIR_NLINK)
 934 EXT4_FEATURE_RO_COMPAT_FUNCS(extra_isize,       4, EXTRA_ISIZE)
 935 EXT4_FEATURE_RO_COMPAT_FUNCS(has_snapshot,      4, HAS_SNAPSHOT)
 936 EXT4_FEATURE_RO_COMPAT_FUNCS(quota,             4, QUOTA)
 937 EXT4_FEATURE_RO_COMPAT_FUNCS(bigalloc,          4, BIGALLOC)
 938 EXT4_FEATURE_RO_COMPAT_FUNCS(metadata_csum,     4, METADATA_CSUM)
 939 EXT4_FEATURE_RO_COMPAT_FUNCS(replica,           4, REPLICA)
 940 EXT4_FEATURE_RO_COMPAT_FUNCS(readonly,          4, READONLY)
 941 EXT4_FEATURE_RO_COMPAT_FUNCS(project,           4, PROJECT)
 942 EXT4_FEATURE_RO_COMPAT_FUNCS(shared_blocks,     4, SHARED_BLOCKS)
 943 EXT4_FEATURE_RO_COMPAT_FUNCS(verity,            4, VERITY)
 944
 945 EXT4_FEATURE_INCOMPAT_FUNCS(compression,        2, COMPRESSION)
 946 EXT4_FEATURE_INCOMPAT_FUNCS(filetype,           2, FILETYPE)
 947 EXT4_FEATURE_INCOMPAT_FUNCS(journal_needs_recovery,     3, RECOVER)
 948 EXT4_FEATURE_INCOMPAT_FUNCS(journal_dev,        3, JOURNAL_DEV)
 949 EXT4_FEATURE_INCOMPAT_FUNCS(meta_bg,            2, META_BG)
 950 EXT4_FEATURE_INCOMPAT_FUNCS(extents,            3, EXTENTS)
 951 EXT4_FEATURE_INCOMPAT_FUNCS(64bit,              4, 64BIT)
 952 EXT4_FEATURE_INCOMPAT_FUNCS(mmp,                4, MMP)
 953 EXT4_FEATURE_INCOMPAT_FUNCS(flex_bg,            4, FLEX_BG)
 954 EXT4_FEATURE_INCOMPAT_FUNCS(ea_inode,           4, EA_INODE)
 955 EXT4_FEATURE_INCOMPAT_FUNCS(dirdata,            4, DIRDATA)
 956 EXT4_FEATURE_INCOMPAT_FUNCS(csum_seed,          4, CSUM_SEED)
 957 EXT4_FEATURE_INCOMPAT_FUNCS(largedir,           4, LARGEDIR)
 958 EXT4_FEATURE_INCOMPAT_FUNCS(inline_data,        4, INLINE_DATA)
 959 EXT4_FEATURE_INCOMPAT_FUNCS(encrypt,            4, ENCRYPT)
 960 EXT4_FEATURE_INCOMPAT_FUNCS(casefold,           4, CASEFOLD)
 961
 962 #define EXT2_FEATURE_COMPAT_SUPP        0
 963 #define EXT2_FEATURE_INCOMPAT_SUPP    (EXT2_FEATURE_INCOMPAT_FILETYPE| \
 964                                        EXT4_FEATURE_INCOMPAT_MMP| \
 965                                        EXT4_FEATURE_INCOMPAT_LARGEDIR| \
 966                                        EXT4_FEATURE_INCOMPAT_EA_INODE| \
 967                                        EXT4_FEATURE_INCOMPAT_DIRDATA)
 968 #define EXT2_FEATURE_RO_COMPAT_SUPP     (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
 969                                          EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
 970                                          EXT4_FEATURE_RO_COMPAT_DIR_NLINK| \
 971                                          EXT2_FEATURE_RO_COMPAT_BTREE_DIR| \
 972                                          EXT4_FEATURE_RO_COMPAT_VERITY| \
 973                                          EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE)
 974
 975 /*
 976  * Default values for user and/or group using reserved blocks
 977  */
 978 #define EXT2_DEF_RESUID         0
 979 #define EXT2_DEF_RESGID         0
 980
 981 /*
 982  * Default mount options
 983  */
 984 #define EXT2_DEFM_DEBUG         0x0001
 985 #define EXT2_DEFM_BSDGROUPS     0x0002
 986 #define EXT2_DEFM_XATTR_USER    0x0004
 987 #define EXT2_DEFM_ACL           0x0008
 988 #define EXT2_DEFM_UID16         0x0010
 989 #define EXT3_DEFM_JMODE         0x0060
 990 #define EXT3_DEFM_JMODE_DATA    0x0020
 991 #define EXT3_DEFM_JMODE_ORDERED 0x0040
 992 #define EXT3_DEFM_JMODE_WBACK   0x0060
 993 #define EXT4_DEFM_NOBARRIER     0x0100
 994 #define EXT4_DEFM_BLOCK_VALIDITY 0x0200
 995 #define EXT4_DEFM_DISCARD       0x0400
 996 #define EXT4_DEFM_NODELALLOC    0x0800
 997
 998 static inline int ext4_hash_in_dirent(const struct ext2_inode *inode)
 999 {
1000         return (inode->i_flags & EXT4_ENCRYPT_FL) &&
1001                 (inode->i_flags & EXT4_CASEFOLD_FL);
1002 }
1003
1004 /*
1005  * Structure of a directory entry
1006  */
1007 #define EXT2_NAME_LEN 255
1008
1009 struct ext2_dir_entry {
1010         __u32   inode;                  /* Inode number */
1011         __u16   rec_len;                /* Directory entry length */
1012         __u16   name_len;               /* Name length */
1013         char    name[EXT2_NAME_LEN];    /* File name */
1014 };
1015
1016 /*
1017  * The new version of the directory entry.  Since EXT2 structures are
1018  * stored in intel byte order, and the name_len field could never be
1019  * bigger than 255 chars, it's safe to reclaim the extra byte for the
1020  * file_type field.
1021  *
1022  * This structure is deprecated due to endian issues. Please use struct
1023  * ext2_dir_entry and accessor functions
1024  *   ext2fs_dirent_name_len
1025  *   ext2fs_dirent_set_name_len
1026  *   ext2fs_dirent_file_type
1027  *   ext2fs_dirent_set_file_type
1028  * to get and set name_len and file_type fields.
1029  */
1030 struct ext2_dir_entry_2 {
1031         __u32   inode;                  /* Inode number */
1032         __u16   rec_len;                /* Directory entry length */
1033         __u8    name_len;               /* Name length */
1034         __u8    file_type;
1035         char    name[EXT2_NAME_LEN];    /* File name */
1036 };
1037
1038 /*
1039  * Hashes for ext4_dir_entry for casefolded and ecrypted directories.
1040  * This is located at the first 4 bit aligned location after the name.
1041  */
1042
1043 struct ext2_dir_entry_hash {
1044         __le32 hash;
1045         __le32 minor_hash;
1046 };
1047
1048 #define EXT2_DIRENT_HASHES(entry) \
1049         ((struct ext2_dir_entry_hash *) &entry->name[\
1050                 (ext2fs_dirent_name_len(entry) + \
1051                         EXT2_DIR_ROUND) & ~EXT2_DIR_ROUND])
1052 #define EXT2_DIRENT_HASH(entry) \
1053                 ext2fs_le32_to_cpu(EXT2_DIRENT_HASHES(entry)->hash)
1054 #define EXT2_DIRENT_MINOR_HASH(entry) \
1055                 ext2fs_le32_to_cpu(EXT2_DIRENT_HASHES(entry)->minor_hash)
1056
1057 /*
1058  * This is a bogus directory entry at the end of each leaf block that
1059  * records checksums.
1060  */
1061 struct ext2_dir_entry_tail {
1062         __u32   det_reserved_zero1;     /* Pretend to be unused */
1063         __u16   det_rec_len;            /* 12 */
1064         __u16   det_reserved_name_len;  /* 0xDE00, fake namelen/filetype */
1065         __u32   det_checksum;           /* crc32c(uuid+inode+dirent) */
1066 };
1067
1068 /*
1069  * Ext2 directory file types.  Only the low 3 bits are used.  The
1070  * other bits are reserved for now.
1071  */
1072 #define EXT2_FT_UNKNOWN         0
1073 #define EXT2_FT_REG_FILE        1
1074 #define EXT2_FT_DIR             2
1075 #define EXT2_FT_CHRDEV          3
1076 #define EXT2_FT_BLKDEV          4
1077 #define EXT2_FT_FIFO            5
1078 #define EXT2_FT_SOCK            6
1079 #define EXT2_FT_SYMLINK         7
1080
1081 #define EXT2_FT_MAX             8
1082 #define EXT2_FT_MASK            0x0f
1083
1084 /*
1085  * Annoyingly, e2fsprogs always swab16s ext2_dir_entry.name_len, so we
1086  * have to build ext2_dir_entry_tail with that assumption too.  This
1087  * constant helps to build the dir_entry_tail to look like it has an
1088  * "invalid" file type.
1089  */
1090 #define EXT2_DIR_NAME_LEN_CSUM  0xDE00
1091
1092 int ext2_get_dirdata_field_size(struct ext2_dir_entry *de, char dirdata_flags);
1093 int ext2_get_dirdata_size(struct ext2_dir_entry *de);
1094
1095 /*
1096  * EXT2_DIR_PAD defines the directory entries boundaries
1097  *
1098  * NOTE: It must be a multiple of 4
1099  */
1100 #define EXT2_DIR_ENTRY_HEADER_LEN       8
1101 #define EXT2_DIR_ENTRY_HASH_LEN         8
1102 #define EXT2_DIR_PAD                    4
1103 #define EXT2_DIR_ROUND                  (EXT2_DIR_PAD - 1)
1104 #define EXT2_DIR_NAME_LEN(name_len)     (((name_len) + \
1105                                           EXT2_DIR_ENTRY_HEADER_LEN + \
1106                                           EXT2_DIR_ROUND) & \
1107                                          ~EXT2_DIR_ROUND)
1108 #define EXT2_DIR_REC_LEN(de)    (EXT2_DIR_NAME_LEN(((de)->name_len &         \
1109                                                      EXT2_NAME_LEN) +         \
1110                                                     ext2_get_dirdata_size(de)))
1111
1112 static inline unsigned int ext2fs_dir_rec_len(__u8 name_len,
1113                                                 int extended)
1114 {
1115         int rec_len = (name_len + EXT2_DIR_ENTRY_HEADER_LEN + EXT2_DIR_ROUND);
1116
1117         rec_len &= ~EXT2_DIR_ROUND;
1118         if (extended)
1119                 rec_len += EXT2_DIR_ENTRY_HASH_LEN;
1120         return rec_len;
1121 }
1122
1123 static inline unsigned int ext2fs_dirdata_rec_len(struct ext2_dir_entry *de,
1124                                                 int extended)
1125 {
1126         int rec_len = EXT2_DIR_REC_LEN(de);
1127
1128         if (extended)
1129                 rec_len += EXT2_DIR_ENTRY_HASH_LEN;
1130         return rec_len;
1131 }
1132
1133 /* lu_fid size and NUL char */
1134 #define EXT2_DIRENT_LUFID_SIZE          16
1135 #define EXT2_DIRENT_LUFID               0x10
1136
1137 /*
1138  * Constants for ext4's extended time encoding
1139  */
1140 #define EXT4_EPOCH_BITS 2
1141 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
1142 #define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)
1143
1144 /*
1145  * This structure is used for multiple mount protection. It is written
1146  * into the block number saved in the s_mmp_block field in the superblock.
1147  * Programs that check MMP should assume that if SEQ_FSCK (or any unknown
1148  * code above SEQ_MAX) is present then it is NOT safe to use the filesystem,
1149  * regardless of how old the timestamp is.
1150  *
1151  * The timestamp in the MMP structure will be updated by e2fsck at some
1152  * arbitrary intervals (start of passes, after every few groups of inodes
1153  * in pass1 and pass1b).  There is no guarantee that e2fsck is updating
1154  * the MMP block in a timely manner, and the updates it does are purely
1155  * for the convenience of the sysadmin and not for automatic validation.
1156  *
1157  * Note: Only the mmp_seq value is used to determine whether the MMP block
1158  *      is being updated.  The mmp_time, mmp_nodename, and mmp_bdevname
1159  *      fields are only for informational purposes for the administrator,
1160  *      due to clock skew between nodes and hostname HA service takeover.
1161  */
1162 #define EXT4_MMP_MAGIC     0x004D4D50U /* ASCII for MMP */
1163 #define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
1164 #define EXT4_MMP_SEQ_FSCK  0xE24D4D50U /* mmp_seq value when being fscked */
1165 #define EXT4_MMP_SEQ_MAX   0xE24D4D4FU /* maximum valid mmp_seq value */
1166
1167 /* Not endian-annotated; it's swapped at read/write time */
1168 struct mmp_struct {
1169         __u32   mmp_magic;              /* Magic number for MMP */
1170         __u32   mmp_seq;                /* Sequence no. updated periodically */
1171         __u64   mmp_time;               /* Time last updated (seconds) */
1172         __u8    mmp_nodename[64];       /* Node updating MMP block, no NUL? */
1173         __u8    mmp_bdevname[32];       /* Bdev updating MMP block, no NUL? */
1174         __u16   mmp_check_interval;     /* Changed mmp_check_interval */
1175         __u16   mmp_pad1;
1176         __u32   mmp_pad2[226];
1177         __u32   mmp_checksum;           /* crc32c(uuid+mmp_block) */
1178 };
1179
1180 /*
1181  * Default interval for MMP update in seconds.
1182  */
1183 #define EXT4_MMP_UPDATE_INTERVAL        5
1184
1185 /*
1186  * Maximum interval for MMP update in seconds.
1187  */
1188 #define EXT4_MMP_MAX_UPDATE_INTERVAL    300
1189
1190 /*
1191  * Minimum interval for MMP checking in seconds.
1192  */
1193 #define EXT4_MMP_MIN_CHECK_INTERVAL     5
1194
1195 /*
1196  * Minimum size of inline data.
1197  */
1198 #define EXT4_MIN_INLINE_DATA_SIZE       ((sizeof(__u32) * EXT2_N_BLOCKS))
1199
1200 /*
1201  * Size of a parent inode in inline data directory.
1202  */
1203 #define EXT4_INLINE_DATA_DOTDOT_SIZE    (4)
1204
1205 #define EXT4_ENC_UTF8_12_1      1
1206
1207 #define EXT4_ENC_STRICT_MODE_FL                 (1 << 0) /* Reject invalid sequences */
1208
1209 #define EXT2_NEXT_DIRENT(d)     ((void *)((char *)(d) + (d)->rec_len))
1210
1211 #endif  /* _LINUX_EXT2_FS_H */