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