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