Pileus Git - ~andy/linux/blob - fs/ext4/ext4.h

   1 /*
   2  *  ext4.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 _EXT4_H
  17 #define _EXT4_H
  18
  19 #include <linux/types.h>
  20 #include <linux/blkdev.h>
  21 #include <linux/magic.h>
  22 #include <linux/jbd2.h>
  23 #include <linux/quota.h>
  24 #include <linux/rwsem.h>
  25 #include <linux/rbtree.h>
  26 #include <linux/seqlock.h>
  27 #include <linux/mutex.h>
  28 #include <linux/timer.h>
  29 #include <linux/wait.h>
  30 #include <linux/blockgroup_lock.h>
  31 #include <linux/percpu_counter.h>
  32 #include <crypto/hash.h>
  33 #ifdef __KERNEL__
  34 #include <linux/compat.h>
  35 #endif
  36
  37 /*
  38  * The fourth extended filesystem constants/structures
  39  */
  40
  41 /*
  42  * Define EXT4FS_DEBUG to produce debug messages
  43  */
  44 #undef EXT4FS_DEBUG
  45
  46 /*
  47  * Debug code
  48  */
  49 #ifdef EXT4FS_DEBUG
  50 #define ext4_debug(f, a...)                                             \
  51         do {                                                            \
  52                 printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:",        \
  53                         __FILE__, __LINE__, __func__);                  \
  54                 printk(KERN_DEBUG f, ## a);                             \
  55         } while (0)
  56 #else
  57 #define ext4_debug(fmt, ...)    no_printk(fmt, ##__VA_ARGS__)
  58 #endif
  59
  60 /*
  61  * Turn on EXT_DEBUG to get lots of info about extents operations.
  62  */
  63 #define EXT_DEBUG__
  64 #ifdef EXT_DEBUG
  65 #define ext_debug(fmt, ...)     printk(fmt, ##__VA_ARGS__)
  66 #else
  67 #define ext_debug(fmt, ...)     no_printk(fmt, ##__VA_ARGS__)
  68 #endif
  69
  70 #define EXT4_ERROR_INODE(inode, fmt, a...) \
  71         ext4_error_inode((inode), __func__, __LINE__, 0, (fmt), ## a)
  72
  73 #define EXT4_ERROR_INODE_BLOCK(inode, block, fmt, a...)                 \
  74         ext4_error_inode((inode), __func__, __LINE__, (block), (fmt), ## a)
  75
  76 #define EXT4_ERROR_FILE(file, block, fmt, a...)                         \
  77         ext4_error_file((file), __func__, __LINE__, (block), (fmt), ## a)
  78
  79 /* data type for block offset of block group */
  80 typedef int ext4_grpblk_t;
  81
  82 /* data type for filesystem-wide blocks number */
  83 typedef unsigned long long ext4_fsblk_t;
  84
  85 /* data type for file logical block number */
  86 typedef __u32 ext4_lblk_t;
  87
  88 /* data type for block group number */
  89 typedef unsigned int ext4_group_t;
  90
  91 /*
  92  * Flags used in mballoc's allocation_context flags field.
  93  *
  94  * Also used to show what's going on for debugging purposes when the
  95  * flag field is exported via the traceport interface
  96  */
  97
  98 /* prefer goal again. length */
  99 #define EXT4_MB_HINT_MERGE              0x0001
 100 /* blocks already reserved */
 101 #define EXT4_MB_HINT_RESERVED           0x0002
 102 /* metadata is being allocated */
 103 #define EXT4_MB_HINT_METADATA           0x0004
 104 /* first blocks in the file */
 105 #define EXT4_MB_HINT_FIRST              0x0008
 106 /* search for the best chunk */
 107 #define EXT4_MB_HINT_BEST               0x0010
 108 /* data is being allocated */
 109 #define EXT4_MB_HINT_DATA               0x0020
 110 /* don't preallocate (for tails) */
 111 #define EXT4_MB_HINT_NOPREALLOC         0x0040
 112 /* allocate for locality group */
 113 #define EXT4_MB_HINT_GROUP_ALLOC        0x0080
 114 /* allocate goal blocks or none */
 115 #define EXT4_MB_HINT_GOAL_ONLY          0x0100
 116 /* goal is meaningful */
 117 #define EXT4_MB_HINT_TRY_GOAL           0x0200
 118 /* blocks already pre-reserved by delayed allocation */
 119 #define EXT4_MB_DELALLOC_RESERVED       0x0400
 120 /* We are doing stream allocation */
 121 #define EXT4_MB_STREAM_ALLOC            0x0800
 122 /* Use reserved root blocks if needed */
 123 #define EXT4_MB_USE_ROOT_BLOCKS         0x1000
 124 /* Use blocks from reserved pool */
 125 #define EXT4_MB_USE_RESERVED            0x2000
 126
 127 struct ext4_allocation_request {
 128         /* target inode for block we're allocating */
 129         struct inode *inode;
 130         /* how many blocks we want to allocate */
 131         unsigned int len;
 132         /* logical block in target inode */
 133         ext4_lblk_t logical;
 134         /* the closest logical allocated block to the left */
 135         ext4_lblk_t lleft;
 136         /* the closest logical allocated block to the right */
 137         ext4_lblk_t lright;
 138         /* phys. target (a hint) */
 139         ext4_fsblk_t goal;
 140         /* phys. block for the closest logical allocated block to the left */
 141         ext4_fsblk_t pleft;
 142         /* phys. block for the closest logical allocated block to the right */
 143         ext4_fsblk_t pright;
 144         /* flags. see above EXT4_MB_HINT_* */
 145         unsigned int flags;
 146 };
 147
 148 /*
 149  * Logical to physical block mapping, used by ext4_map_blocks()
 150  *
 151  * This structure is used to pass requests into ext4_map_blocks() as
 152  * well as to store the information returned by ext4_map_blocks().  It
 153  * takes less room on the stack than a struct buffer_head.
 154  */
 155 #define EXT4_MAP_NEW            (1 << BH_New)
 156 #define EXT4_MAP_MAPPED         (1 << BH_Mapped)
 157 #define EXT4_MAP_UNWRITTEN      (1 << BH_Unwritten)
 158 #define EXT4_MAP_BOUNDARY       (1 << BH_Boundary)
 159 #define EXT4_MAP_UNINIT         (1 << BH_Uninit)
 160 /* Sometimes (in the bigalloc case, from ext4_da_get_block_prep) the caller of
 161  * ext4_map_blocks wants to know whether or not the underlying cluster has
 162  * already been accounted for. EXT4_MAP_FROM_CLUSTER conveys to the caller that
 163  * the requested mapping was from previously mapped (or delayed allocated)
 164  * cluster. We use BH_AllocFromCluster only for this flag. BH_AllocFromCluster
 165  * should never appear on buffer_head's state flags.
 166  */
 167 #define EXT4_MAP_FROM_CLUSTER   (1 << BH_AllocFromCluster)
 168 #define EXT4_MAP_FLAGS          (EXT4_MAP_NEW | EXT4_MAP_MAPPED |\
 169                                  EXT4_MAP_UNWRITTEN | EXT4_MAP_BOUNDARY |\
 170                                  EXT4_MAP_UNINIT | EXT4_MAP_FROM_CLUSTER)
 171
 172 struct ext4_map_blocks {
 173         ext4_fsblk_t m_pblk;
 174         ext4_lblk_t m_lblk;
 175         unsigned int m_len;
 176         unsigned int m_flags;
 177 };
 178
 179 /*
 180  * Flags for ext4_io_end->flags
 181  */
 182 #define EXT4_IO_END_UNWRITTEN   0x0001
 183 #define EXT4_IO_END_DIRECT      0x0002
 184
 185 /*
 186  * For converting uninitialized extents on a work queue. 'handle' is used for
 187  * buffered writeback.
 188  */
 189 typedef struct ext4_io_end {
 190         struct list_head        list;           /* per-file finished IO list */
 191         handle_t                *handle;        /* handle reserved for extent
 192                                                  * conversion */
 193         struct inode            *inode;         /* file being written to */
 194         struct bio              *bio;           /* Linked list of completed
 195                                                  * bios covering the extent */
 196         unsigned int            flag;           /* unwritten or not */
 197         loff_t                  offset;         /* offset in the file */
 198         ssize_t                 size;           /* size of the extent */
 199         struct kiocb            *iocb;          /* iocb struct for AIO */
 200         int                     result;         /* error value for AIO */
 201         atomic_t                count;          /* reference counter */
 202 } ext4_io_end_t;
 203
 204 struct ext4_io_submit {
 205         int                     io_op;
 206         struct bio              *io_bio;
 207         ext4_io_end_t           *io_end;
 208         sector_t                io_next_block;
 209 };
 210
 211 /*
 212  * Special inodes numbers
 213  */
 214 #define EXT4_BAD_INO             1      /* Bad blocks inode */
 215 #define EXT4_ROOT_INO            2      /* Root inode */
 216 #define EXT4_USR_QUOTA_INO       3      /* User quota inode */
 217 #define EXT4_GRP_QUOTA_INO       4      /* Group quota inode */
 218 #define EXT4_BOOT_LOADER_INO     5      /* Boot loader inode */
 219 #define EXT4_UNDEL_DIR_INO       6      /* Undelete directory inode */
 220 #define EXT4_RESIZE_INO          7      /* Reserved group descriptors inode */
 221 #define EXT4_JOURNAL_INO         8      /* Journal inode */
 222
 223 /* First non-reserved inode for old ext4 filesystems */
 224 #define EXT4_GOOD_OLD_FIRST_INO 11
 225
 226 /*
 227  * Maximal count of links to a file
 228  */
 229 #define EXT4_LINK_MAX           65000
 230
 231 /*
 232  * Macro-instructions used to manage several block sizes
 233  */
 234 #define EXT4_MIN_BLOCK_SIZE             1024
 235 #define EXT4_MAX_BLOCK_SIZE             65536
 236 #define EXT4_MIN_BLOCK_LOG_SIZE         10
 237 #define EXT4_MAX_BLOCK_LOG_SIZE         16
 238 #ifdef __KERNEL__
 239 # define EXT4_BLOCK_SIZE(s)             ((s)->s_blocksize)
 240 #else
 241 # define EXT4_BLOCK_SIZE(s)             (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
 242 #endif
 243 #define EXT4_ADDR_PER_BLOCK(s)          (EXT4_BLOCK_SIZE(s) / sizeof(__u32))
 244 #define EXT4_CLUSTER_SIZE(s)            (EXT4_BLOCK_SIZE(s) << \
 245                                          EXT4_SB(s)->s_cluster_bits)
 246 #ifdef __KERNEL__
 247 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_blocksize_bits)
 248 # define EXT4_CLUSTER_BITS(s)           (EXT4_SB(s)->s_cluster_bits)
 249 #else
 250 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_log_block_size + 10)
 251 #endif
 252 #ifdef __KERNEL__
 253 #define EXT4_ADDR_PER_BLOCK_BITS(s)     (EXT4_SB(s)->s_addr_per_block_bits)
 254 #define EXT4_INODE_SIZE(s)              (EXT4_SB(s)->s_inode_size)
 255 #define EXT4_FIRST_INO(s)               (EXT4_SB(s)->s_first_ino)
 256 #else
 257 #define EXT4_INODE_SIZE(s)      (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
 258                                  EXT4_GOOD_OLD_INODE_SIZE : \
 259                                  (s)->s_inode_size)
 260 #define EXT4_FIRST_INO(s)       (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
 261                                  EXT4_GOOD_OLD_FIRST_INO : \
 262                                  (s)->s_first_ino)
 263 #endif
 264 #define EXT4_BLOCK_ALIGN(size, blkbits)         ALIGN((size), (1 << (blkbits)))
 265
 266 /* Translate a block number to a cluster number */
 267 #define EXT4_B2C(sbi, blk)      ((blk) >> (sbi)->s_cluster_bits)
 268 /* Translate a cluster number to a block number */
 269 #define EXT4_C2B(sbi, cluster)  ((cluster) << (sbi)->s_cluster_bits)
 270 /* Translate # of blks to # of clusters */
 271 #define EXT4_NUM_B2C(sbi, blks) (((blks) + (sbi)->s_cluster_ratio - 1) >> \
 272                                  (sbi)->s_cluster_bits)
 273
 274 /*
 275  * Structure of a blocks group descriptor
 276  */
 277 struct ext4_group_desc
 278 {
 279         __le32  bg_block_bitmap_lo;     /* Blocks bitmap block */
 280         __le32  bg_inode_bitmap_lo;     /* Inodes bitmap block */
 281         __le32  bg_inode_table_lo;      /* Inodes table block */
 282         __le16  bg_free_blocks_count_lo;/* Free blocks count */
 283         __le16  bg_free_inodes_count_lo;/* Free inodes count */
 284         __le16  bg_used_dirs_count_lo;  /* Directories count */
 285         __le16  bg_flags;               /* EXT4_BG_flags (INODE_UNINIT, etc) */
 286         __le32  bg_exclude_bitmap_lo;   /* Exclude bitmap for snapshots */
 287         __le16  bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bbitmap) LE */
 288         __le16  bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+ibitmap) LE */
 289         __le16  bg_itable_unused_lo;    /* Unused inodes count */
 290         __le16  bg_checksum;            /* crc16(sb_uuid+group+desc) */
 291         __le32  bg_block_bitmap_hi;     /* Blocks bitmap block MSB */
 292         __le32  bg_inode_bitmap_hi;     /* Inodes bitmap block MSB */
 293         __le32  bg_inode_table_hi;      /* Inodes table block MSB */
 294         __le16  bg_free_blocks_count_hi;/* Free blocks count MSB */
 295         __le16  bg_free_inodes_count_hi;/* Free inodes count MSB */
 296         __le16  bg_used_dirs_count_hi;  /* Directories count MSB */
 297         __le16  bg_itable_unused_hi;    /* Unused inodes count MSB */
 298         __le32  bg_exclude_bitmap_hi;   /* Exclude bitmap block MSB */
 299         __le16  bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bbitmap) BE */
 300         __le16  bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+ibitmap) BE */
 301         __u32   bg_reserved;
 302 };
 303
 304 #define EXT4_BG_INODE_BITMAP_CSUM_HI_END        \
 305         (offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
 306          sizeof(__le16))
 307 #define EXT4_BG_BLOCK_BITMAP_CSUM_HI_END        \
 308         (offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
 309          sizeof(__le16))
 310
 311 /*
 312  * Structure of a flex block group info
 313  */
 314
 315 struct flex_groups {
 316         atomic64_t      free_clusters;
 317         atomic_t        free_inodes;
 318         atomic_t        used_dirs;
 319 };
 320
 321 #define EXT4_BG_INODE_UNINIT    0x0001 /* Inode table/bitmap not in use */
 322 #define EXT4_BG_BLOCK_UNINIT    0x0002 /* Block bitmap not in use */
 323 #define EXT4_BG_INODE_ZEROED    0x0004 /* On-disk itable initialized to zero */
 324
 325 /*
 326  * Macro-instructions used to manage group descriptors
 327  */
 328 #define EXT4_MIN_DESC_SIZE              32
 329 #define EXT4_MIN_DESC_SIZE_64BIT        64
 330 #define EXT4_MAX_DESC_SIZE              EXT4_MIN_BLOCK_SIZE
 331 #define EXT4_DESC_SIZE(s)               (EXT4_SB(s)->s_desc_size)
 332 #ifdef __KERNEL__
 333 # define EXT4_BLOCKS_PER_GROUP(s)       (EXT4_SB(s)->s_blocks_per_group)
 334 # define EXT4_CLUSTERS_PER_GROUP(s)     (EXT4_SB(s)->s_clusters_per_group)
 335 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_SB(s)->s_desc_per_block)
 336 # define EXT4_INODES_PER_GROUP(s)       (EXT4_SB(s)->s_inodes_per_group)
 337 # define EXT4_DESC_PER_BLOCK_BITS(s)    (EXT4_SB(s)->s_desc_per_block_bits)
 338 #else
 339 # define EXT4_BLOCKS_PER_GROUP(s)       ((s)->s_blocks_per_group)
 340 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
 341 # define EXT4_INODES_PER_GROUP(s)       ((s)->s_inodes_per_group)
 342 #endif
 343
 344 /*
 345  * Constants relative to the data blocks
 346  */
 347 #define EXT4_NDIR_BLOCKS                12
 348 #define EXT4_IND_BLOCK                  EXT4_NDIR_BLOCKS
 349 #define EXT4_DIND_BLOCK                 (EXT4_IND_BLOCK + 1)
 350 #define EXT4_TIND_BLOCK                 (EXT4_DIND_BLOCK + 1)
 351 #define EXT4_N_BLOCKS                   (EXT4_TIND_BLOCK + 1)
 352
 353 /*
 354  * Inode flags
 355  */
 356 #define EXT4_SECRM_FL                   0x00000001 /* Secure deletion */
 357 #define EXT4_UNRM_FL                    0x00000002 /* Undelete */
 358 #define EXT4_COMPR_FL                   0x00000004 /* Compress file */
 359 #define EXT4_SYNC_FL                    0x00000008 /* Synchronous updates */
 360 #define EXT4_IMMUTABLE_FL               0x00000010 /* Immutable file */
 361 #define EXT4_APPEND_FL                  0x00000020 /* writes to file may only append */
 362 #define EXT4_NODUMP_FL                  0x00000040 /* do not dump file */
 363 #define EXT4_NOATIME_FL                 0x00000080 /* do not update atime */
 364 /* Reserved for compression usage... */
 365 #define EXT4_DIRTY_FL                   0x00000100
 366 #define EXT4_COMPRBLK_FL                0x00000200 /* One or more compressed clusters */
 367 #define EXT4_NOCOMPR_FL                 0x00000400 /* Don't compress */
 368 #define EXT4_ECOMPR_FL                  0x00000800 /* Compression error */
 369 /* End compression flags --- maybe not all used */
 370 #define EXT4_INDEX_FL                   0x00001000 /* hash-indexed directory */
 371 #define EXT4_IMAGIC_FL                  0x00002000 /* AFS directory */
 372 #define EXT4_JOURNAL_DATA_FL            0x00004000 /* file data should be journaled */
 373 #define EXT4_NOTAIL_FL                  0x00008000 /* file tail should not be merged */
 374 #define EXT4_DIRSYNC_FL                 0x00010000 /* dirsync behaviour (directories only) */
 375 #define EXT4_TOPDIR_FL                  0x00020000 /* Top of directory hierarchies*/
 376 #define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
 377 #define EXT4_EXTENTS_FL                 0x00080000 /* Inode uses extents */
 378 #define EXT4_EA_INODE_FL                0x00200000 /* Inode used for large EA */
 379 #define EXT4_EOFBLOCKS_FL               0x00400000 /* Blocks allocated beyond EOF */
 380 #define EXT4_INLINE_DATA_FL             0x10000000 /* Inode has inline data. */
 381 #define EXT4_RESERVED_FL                0x80000000 /* reserved for ext4 lib */
 382
 383 #define EXT4_FL_USER_VISIBLE            0x004BDFFF /* User visible flags */
 384 #define EXT4_FL_USER_MODIFIABLE         0x004380FF /* User modifiable flags */
 385
 386 /* Flags that should be inherited by new inodes from their parent. */
 387 #define EXT4_FL_INHERITED (EXT4_SECRM_FL | EXT4_UNRM_FL | EXT4_COMPR_FL |\
 388                            EXT4_SYNC_FL | EXT4_NODUMP_FL | EXT4_NOATIME_FL |\
 389                            EXT4_NOCOMPR_FL | EXT4_JOURNAL_DATA_FL |\
 390                            EXT4_NOTAIL_FL | EXT4_DIRSYNC_FL)
 391
 392 /* Flags that are appropriate for regular files (all but dir-specific ones). */
 393 #define EXT4_REG_FLMASK (~(EXT4_DIRSYNC_FL | EXT4_TOPDIR_FL))
 394
 395 /* Flags that are appropriate for non-directories/regular files. */
 396 #define EXT4_OTHER_FLMASK (EXT4_NODUMP_FL | EXT4_NOATIME_FL)
 397
 398 /* Mask out flags that are inappropriate for the given type of inode. */
 399 static inline __u32 ext4_mask_flags(umode_t mode, __u32 flags)
 400 {
 401         if (S_ISDIR(mode))
 402                 return flags;
 403         else if (S_ISREG(mode))
 404                 return flags & EXT4_REG_FLMASK;
 405         else
 406                 return flags & EXT4_OTHER_FLMASK;
 407 }
 408
 409 /*
 410  * Inode flags used for atomic set/get
 411  */
 412 enum {
 413         EXT4_INODE_SECRM        = 0,    /* Secure deletion */
 414         EXT4_INODE_UNRM         = 1,    /* Undelete */
 415         EXT4_INODE_COMPR        = 2,    /* Compress file */
 416         EXT4_INODE_SYNC         = 3,    /* Synchronous updates */
 417         EXT4_INODE_IMMUTABLE    = 4,    /* Immutable file */
 418         EXT4_INODE_APPEND       = 5,    /* writes to file may only append */
 419         EXT4_INODE_NODUMP       = 6,    /* do not dump file */
 420         EXT4_INODE_NOATIME      = 7,    /* do not update atime */
 421 /* Reserved for compression usage... */
 422         EXT4_INODE_DIRTY        = 8,
 423         EXT4_INODE_COMPRBLK     = 9,    /* One or more compressed clusters */
 424         EXT4_INODE_NOCOMPR      = 10,   /* Don't compress */
 425         EXT4_INODE_ECOMPR       = 11,   /* Compression error */
 426 /* End compression flags --- maybe not all used */
 427         EXT4_INODE_INDEX        = 12,   /* hash-indexed directory */
 428         EXT4_INODE_IMAGIC       = 13,   /* AFS directory */
 429         EXT4_INODE_JOURNAL_DATA = 14,   /* file data should be journaled */
 430         EXT4_INODE_NOTAIL       = 15,   /* file tail should not be merged */
 431         EXT4_INODE_DIRSYNC      = 16,   /* dirsync behaviour (directories only) */
 432         EXT4_INODE_TOPDIR       = 17,   /* Top of directory hierarchies*/
 433         EXT4_INODE_HUGE_FILE    = 18,   /* Set to each huge file */
 434         EXT4_INODE_EXTENTS      = 19,   /* Inode uses extents */
 435         EXT4_INODE_EA_INODE     = 21,   /* Inode used for large EA */
 436         EXT4_INODE_EOFBLOCKS    = 22,   /* Blocks allocated beyond EOF */
 437         EXT4_INODE_INLINE_DATA  = 28,   /* Data in inode. */
 438         EXT4_INODE_RESERVED     = 31,   /* reserved for ext4 lib */
 439 };
 440
 441 /*
 442  * Since it's pretty easy to mix up bit numbers and hex values, we use a
 443  * build-time check to make sure that EXT4_XXX_FL is consistent with respect to
 444  * EXT4_INODE_XXX. If all is well, the macros will be dropped, so, it won't cost
 445  * any extra space in the compiled kernel image, otherwise, the build will fail.
 446  * It's important that these values are the same, since we are using
 447  * EXT4_INODE_XXX to test for flag values, but EXT4_XXX_FL must be consistent
 448  * with the values of FS_XXX_FL defined in include/linux/fs.h and the on-disk
 449  * values found in ext2, ext3 and ext4 filesystems, and of course the values
 450  * defined in e2fsprogs.
 451  *
 452  * It's not paranoia if the Murphy's Law really *is* out to get you.  :-)
 453  */
 454 #define TEST_FLAG_VALUE(FLAG) (EXT4_##FLAG##_FL == (1 << EXT4_INODE_##FLAG))
 455 #define CHECK_FLAG_VALUE(FLAG) BUILD_BUG_ON(!TEST_FLAG_VALUE(FLAG))
 456
 457 static inline void ext4_check_flag_values(void)
 458 {
 459         CHECK_FLAG_VALUE(SECRM);
 460         CHECK_FLAG_VALUE(UNRM);
 461         CHECK_FLAG_VALUE(COMPR);
 462         CHECK_FLAG_VALUE(SYNC);
 463         CHECK_FLAG_VALUE(IMMUTABLE);
 464         CHECK_FLAG_VALUE(APPEND);
 465         CHECK_FLAG_VALUE(NODUMP);
 466         CHECK_FLAG_VALUE(NOATIME);
 467         CHECK_FLAG_VALUE(DIRTY);
 468         CHECK_FLAG_VALUE(COMPRBLK);
 469         CHECK_FLAG_VALUE(NOCOMPR);
 470         CHECK_FLAG_VALUE(ECOMPR);
 471         CHECK_FLAG_VALUE(INDEX);
 472         CHECK_FLAG_VALUE(IMAGIC);
 473         CHECK_FLAG_VALUE(JOURNAL_DATA);
 474         CHECK_FLAG_VALUE(NOTAIL);
 475         CHECK_FLAG_VALUE(DIRSYNC);
 476         CHECK_FLAG_VALUE(TOPDIR);
 477         CHECK_FLAG_VALUE(HUGE_FILE);
 478         CHECK_FLAG_VALUE(EXTENTS);
 479         CHECK_FLAG_VALUE(EA_INODE);
 480         CHECK_FLAG_VALUE(EOFBLOCKS);
 481         CHECK_FLAG_VALUE(INLINE_DATA);
 482         CHECK_FLAG_VALUE(RESERVED);
 483 }
 484
 485 /* Used to pass group descriptor data when online resize is done */
 486 struct ext4_new_group_input {
 487         __u32 group;            /* Group number for this data */
 488         __u64 block_bitmap;     /* Absolute block number of block bitmap */
 489         __u64 inode_bitmap;     /* Absolute block number of inode bitmap */
 490         __u64 inode_table;      /* Absolute block number of inode table start */
 491         __u32 blocks_count;     /* Total number of blocks in this group */
 492         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
 493         __u16 unused;
 494 };
 495
 496 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
 497 struct compat_ext4_new_group_input {
 498         u32 group;
 499         compat_u64 block_bitmap;
 500         compat_u64 inode_bitmap;
 501         compat_u64 inode_table;
 502         u32 blocks_count;
 503         u16 reserved_blocks;
 504         u16 unused;
 505 };
 506 #endif
 507
 508 /* The struct ext4_new_group_input in kernel space, with free_blocks_count */
 509 struct ext4_new_group_data {
 510         __u32 group;
 511         __u64 block_bitmap;
 512         __u64 inode_bitmap;
 513         __u64 inode_table;
 514         __u32 blocks_count;
 515         __u16 reserved_blocks;
 516         __u16 unused;
 517         __u32 free_blocks_count;
 518 };
 519
 520 /* Indexes used to index group tables in ext4_new_group_data */
 521 enum {
 522         BLOCK_BITMAP = 0,       /* block bitmap */
 523         INODE_BITMAP,           /* inode bitmap */
 524         INODE_TABLE,            /* inode tables */
 525         GROUP_TABLE_COUNT,
 526 };
 527
 528 /*
 529  * Flags used by ext4_map_blocks()
 530  */
 531         /* Allocate any needed blocks and/or convert an unitialized
 532            extent to be an initialized ext4 */
 533 #define EXT4_GET_BLOCKS_CREATE                  0x0001
 534         /* Request the creation of an unitialized extent */
 535 #define EXT4_GET_BLOCKS_UNINIT_EXT              0x0002
 536 #define EXT4_GET_BLOCKS_CREATE_UNINIT_EXT       (EXT4_GET_BLOCKS_UNINIT_EXT|\
 537                                                  EXT4_GET_BLOCKS_CREATE)
 538         /* Caller is from the delayed allocation writeout path
 539          * finally doing the actual allocation of delayed blocks */
 540 #define EXT4_GET_BLOCKS_DELALLOC_RESERVE        0x0004
 541         /* caller is from the direct IO path, request to creation of an
 542         unitialized extents if not allocated, split the uninitialized
 543         extent if blocks has been preallocated already*/
 544 #define EXT4_GET_BLOCKS_PRE_IO                  0x0008
 545 #define EXT4_GET_BLOCKS_CONVERT                 0x0010
 546 #define EXT4_GET_BLOCKS_IO_CREATE_EXT           (EXT4_GET_BLOCKS_PRE_IO|\
 547                                          EXT4_GET_BLOCKS_CREATE_UNINIT_EXT)
 548         /* Convert extent to initialized after IO complete */
 549 #define EXT4_GET_BLOCKS_IO_CONVERT_EXT          (EXT4_GET_BLOCKS_CONVERT|\
 550                                          EXT4_GET_BLOCKS_CREATE_UNINIT_EXT)
 551         /* Eventual metadata allocation (due to growing extent tree)
 552          * should not fail, so try to use reserved blocks for that.*/
 553 #define EXT4_GET_BLOCKS_METADATA_NOFAIL         0x0020
 554         /* Don't normalize allocation size (used for fallocate) */
 555 #define EXT4_GET_BLOCKS_NO_NORMALIZE            0x0040
 556         /* Request will not result in inode size update (user for fallocate) */
 557 #define EXT4_GET_BLOCKS_KEEP_SIZE               0x0080
 558         /* Do not take i_data_sem locking in ext4_map_blocks */
 559 #define EXT4_GET_BLOCKS_NO_LOCK                 0x0100
 560         /* Do not put hole in extent cache */
 561 #define EXT4_GET_BLOCKS_NO_PUT_HOLE             0x0200
 562
 563 /*
 564  * The bit position of this flag must not overlap with any of the
 565  * EXT4_GET_BLOCKS_*.  It is used by ext4_ext_find_extent(),
 566  * read_extent_tree_block(), ext4_split_extent_at(),
 567  * ext4_ext_insert_extent(), and ext4_ext_create_new_leaf() to
 568  * indicate that the we shouldn't be caching the extents when reading
 569  * from the extent tree while a truncate or punch hole operation
 570  * is in progress.
 571  */
 572 #define EXT4_EX_NOCACHE                         0x0400
 573
 574 /*
 575  * Flags used by ext4_free_blocks
 576  */
 577 #define EXT4_FREE_BLOCKS_METADATA       0x0001
 578 #define EXT4_FREE_BLOCKS_FORGET         0x0002
 579 #define EXT4_FREE_BLOCKS_VALIDATED      0x0004
 580 #define EXT4_FREE_BLOCKS_NO_QUOT_UPDATE 0x0008
 581 #define EXT4_FREE_BLOCKS_NOFREE_FIRST_CLUSTER   0x0010
 582 #define EXT4_FREE_BLOCKS_NOFREE_LAST_CLUSTER    0x0020
 583
 584 /*
 585  * ioctl commands
 586  */
 587 #define EXT4_IOC_GETFLAGS               FS_IOC_GETFLAGS
 588 #define EXT4_IOC_SETFLAGS               FS_IOC_SETFLAGS
 589 #define EXT4_IOC_GETVERSION             _IOR('f', 3, long)
 590 #define EXT4_IOC_SETVERSION             _IOW('f', 4, long)
 591 #define EXT4_IOC_GETVERSION_OLD         FS_IOC_GETVERSION
 592 #define EXT4_IOC_SETVERSION_OLD         FS_IOC_SETVERSION
 593 #define EXT4_IOC_GETRSVSZ               _IOR('f', 5, long)
 594 #define EXT4_IOC_SETRSVSZ               _IOW('f', 6, long)
 595 #define EXT4_IOC_GROUP_EXTEND           _IOW('f', 7, unsigned long)
 596 #define EXT4_IOC_GROUP_ADD              _IOW('f', 8, struct ext4_new_group_input)
 597 #define EXT4_IOC_MIGRATE                _IO('f', 9)
 598  /* note ioctl 10 reserved for an early version of the FIEMAP ioctl */
 599  /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
 600 #define EXT4_IOC_ALLOC_DA_BLKS          _IO('f', 12)
 601 #define EXT4_IOC_MOVE_EXT               _IOWR('f', 15, struct move_extent)
 602 #define EXT4_IOC_RESIZE_FS              _IOW('f', 16, __u64)
 603 #define EXT4_IOC_SWAP_BOOT              _IO('f', 17)
 604
 605 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
 606 /*
 607  * ioctl commands in 32 bit emulation
 608  */
 609 #define EXT4_IOC32_GETFLAGS             FS_IOC32_GETFLAGS
 610 #define EXT4_IOC32_SETFLAGS             FS_IOC32_SETFLAGS
 611 #define EXT4_IOC32_GETVERSION           _IOR('f', 3, int)
 612 #define EXT4_IOC32_SETVERSION           _IOW('f', 4, int)
 613 #define EXT4_IOC32_GETRSVSZ             _IOR('f', 5, int)
 614 #define EXT4_IOC32_SETRSVSZ             _IOW('f', 6, int)
 615 #define EXT4_IOC32_GROUP_EXTEND         _IOW('f', 7, unsigned int)
 616 #define EXT4_IOC32_GROUP_ADD            _IOW('f', 8, struct compat_ext4_new_group_input)
 617 #define EXT4_IOC32_GETVERSION_OLD       FS_IOC32_GETVERSION
 618 #define EXT4_IOC32_SETVERSION_OLD       FS_IOC32_SETVERSION
 619 #endif
 620
 621 /* Max physical block we can address w/o extents */
 622 #define EXT4_MAX_BLOCK_FILE_PHYS        0xFFFFFFFF
 623
 624 /*
 625  * Structure of an inode on the disk
 626  */
 627 struct ext4_inode {
 628         __le16  i_mode;         /* File mode */
 629         __le16  i_uid;          /* Low 16 bits of Owner Uid */
 630         __le32  i_size_lo;      /* Size in bytes */
 631         __le32  i_atime;        /* Access time */
 632         __le32  i_ctime;        /* Inode Change time */
 633         __le32  i_mtime;        /* Modification time */
 634         __le32  i_dtime;        /* Deletion Time */
 635         __le16  i_gid;          /* Low 16 bits of Group Id */
 636         __le16  i_links_count;  /* Links count */
 637         __le32  i_blocks_lo;    /* Blocks count */
 638         __le32  i_flags;        /* File flags */
 639         union {
 640                 struct {
 641                         __le32  l_i_version;
 642                 } linux1;
 643                 struct {
 644                         __u32  h_i_translator;
 645                 } hurd1;
 646                 struct {
 647                         __u32  m_i_reserved1;
 648                 } masix1;
 649         } osd1;                         /* OS dependent 1 */
 650         __le32  i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
 651         __le32  i_generation;   /* File version (for NFS) */
 652         __le32  i_file_acl_lo;  /* File ACL */
 653         __le32  i_size_high;
 654         __le32  i_obso_faddr;   /* Obsoleted fragment address */
 655         union {
 656                 struct {
 657                         __le16  l_i_blocks_high; /* were l_i_reserved1 */
 658                         __le16  l_i_file_acl_high;
 659                         __le16  l_i_uid_high;   /* these 2 fields */
 660                         __le16  l_i_gid_high;   /* were reserved2[0] */
 661                         __le16  l_i_checksum_lo;/* crc32c(uuid+inum+inode) LE */
 662                         __le16  l_i_reserved;
 663                 } linux2;
 664                 struct {
 665                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
 666                         __u16   h_i_mode_high;
 667                         __u16   h_i_uid_high;
 668                         __u16   h_i_gid_high;
 669                         __u32   h_i_author;
 670                 } hurd2;
 671                 struct {
 672                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
 673                         __le16  m_i_file_acl_high;
 674                         __u32   m_i_reserved2[2];
 675                 } masix2;
 676         } osd2;                         /* OS dependent 2 */
 677         __le16  i_extra_isize;
 678         __le16  i_checksum_hi;  /* crc32c(uuid+inum+inode) BE */
 679         __le32  i_ctime_extra;  /* extra Change time      (nsec << 2 | epoch) */
 680         __le32  i_mtime_extra;  /* extra Modification time(nsec << 2 | epoch) */
 681         __le32  i_atime_extra;  /* extra Access time      (nsec << 2 | epoch) */
 682         __le32  i_crtime;       /* File Creation time */
 683         __le32  i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
 684         __le32  i_version_hi;   /* high 32 bits for 64-bit version */
 685 };
 686
 687 struct move_extent {
 688         __u32 reserved;         /* should be zero */
 689         __u32 donor_fd;         /* donor file descriptor */
 690         __u64 orig_start;       /* logical start offset in block for orig */
 691         __u64 donor_start;      /* logical start offset in block for donor */
 692         __u64 len;              /* block length to be moved */
 693         __u64 moved_len;        /* moved block length */
 694 };
 695
 696 #define EXT4_EPOCH_BITS 2
 697 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
 698 #define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)
 699
 700 /*
 701  * Extended fields will fit into an inode if the filesystem was formatted
 702  * with large inodes (-I 256 or larger) and there are not currently any EAs
 703  * consuming all of the available space. For new inodes we always reserve
 704  * enough space for the kernel's known extended fields, but for inodes
 705  * created with an old kernel this might not have been the case. None of
 706  * the extended inode fields is critical for correct filesystem operation.
 707  * This macro checks if a certain field fits in the inode. Note that
 708  * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
 709  */
 710 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field)   \
 711         ((offsetof(typeof(*ext4_inode), field) +        \
 712           sizeof((ext4_inode)->field))                  \
 713         <= (EXT4_GOOD_OLD_INODE_SIZE +                  \
 714             (einode)->i_extra_isize))                   \
 715
 716 static inline __le32 ext4_encode_extra_time(struct timespec *time)
 717 {
 718        return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
 719                            (time->tv_sec >> 32) & EXT4_EPOCH_MASK : 0) |
 720                           ((time->tv_nsec << EXT4_EPOCH_BITS) & EXT4_NSEC_MASK));
 721 }
 722
 723 static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
 724 {
 725        if (sizeof(time->tv_sec) > 4)
 726                time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
 727                                << 32;
 728        time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> EXT4_EPOCH_BITS;
 729 }
 730
 731 #define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode)                          \
 732 do {                                                                           \
 733         (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec);               \
 734         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
 735                 (raw_inode)->xtime ## _extra =                                 \
 736                                 ext4_encode_extra_time(&(inode)->xtime);       \
 737 } while (0)
 738
 739 #define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode)                        \
 740 do {                                                                           \
 741         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
 742                 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec);      \
 743         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
 744                 (raw_inode)->xtime ## _extra =                                 \
 745                                 ext4_encode_extra_time(&(einode)->xtime);      \
 746 } while (0)
 747
 748 #define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode)                          \
 749 do {                                                                           \
 750         (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime);       \
 751         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
 752                 ext4_decode_extra_time(&(inode)->xtime,                        \
 753                                        raw_inode->xtime ## _extra);            \
 754         else                                                                   \
 755                 (inode)->xtime.tv_nsec = 0;                                    \
 756 } while (0)
 757
 758 #define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode)                        \
 759 do {                                                                           \
 760         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
 761                 (einode)->xtime.tv_sec =                                       \
 762                         (signed)le32_to_cpu((raw_inode)->xtime);               \
 763         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
 764                 ext4_decode_extra_time(&(einode)->xtime,                       \
 765                                        raw_inode->xtime ## _extra);            \
 766         else                                                                   \
 767                 (einode)->xtime.tv_nsec = 0;                                   \
 768 } while (0)
 769
 770 #define i_disk_version osd1.linux1.l_i_version
 771
 772 #if defined(__KERNEL__) || defined(__linux__)
 773 #define i_reserved1     osd1.linux1.l_i_reserved1
 774 #define i_file_acl_high osd2.linux2.l_i_file_acl_high
 775 #define i_blocks_high   osd2.linux2.l_i_blocks_high
 776 #define i_uid_low       i_uid
 777 #define i_gid_low       i_gid
 778 #define i_uid_high      osd2.linux2.l_i_uid_high
 779 #define i_gid_high      osd2.linux2.l_i_gid_high
 780 #define i_checksum_lo   osd2.linux2.l_i_checksum_lo
 781
 782 #elif defined(__GNU__)
 783
 784 #define i_translator    osd1.hurd1.h_i_translator
 785 #define i_uid_high      osd2.hurd2.h_i_uid_high
 786 #define i_gid_high      osd2.hurd2.h_i_gid_high
 787 #define i_author        osd2.hurd2.h_i_author
 788
 789 #elif defined(__masix__)
 790
 791 #define i_reserved1     osd1.masix1.m_i_reserved1
 792 #define i_file_acl_high osd2.masix2.m_i_file_acl_high
 793 #define i_reserved2     osd2.masix2.m_i_reserved2
 794
 795 #endif /* defined(__KERNEL__) || defined(__linux__) */
 796
 797 #include "extents_status.h"
 798
 799 /*
 800  * fourth extended file system inode data in memory
 801  */
 802 struct ext4_inode_info {
 803         __le32  i_data[15];     /* unconverted */
 804         __u32   i_dtime;
 805         ext4_fsblk_t    i_file_acl;
 806
 807         /*
 808          * i_block_group is the number of the block group which contains
 809          * this file's inode.  Constant across the lifetime of the inode,
 810          * it is ued for making block allocation decisions - we try to
 811          * place a file's data blocks near its inode block, and new inodes
 812          * near to their parent directory's inode.
 813          */
 814         ext4_group_t    i_block_group;
 815         ext4_lblk_t     i_dir_start_lookup;
 816 #if (BITS_PER_LONG < 64)
 817         unsigned long   i_state_flags;          /* Dynamic state flags */
 818 #endif
 819         unsigned long   i_flags;
 820
 821         /*
 822          * Extended attributes can be read independently of the main file
 823          * data. Taking i_mutex even when reading would cause contention
 824          * between readers of EAs and writers of regular file data, so
 825          * instead we synchronize on xattr_sem when reading or changing
 826          * EAs.
 827          */
 828         struct rw_semaphore xattr_sem;
 829
 830         struct list_head i_orphan;      /* unlinked but open inodes */
 831
 832         /*
 833          * i_disksize keeps track of what the inode size is ON DISK, not
 834          * in memory.  During truncate, i_size is set to the new size by
 835          * the VFS prior to calling ext4_truncate(), but the filesystem won't
 836          * set i_disksize to 0 until the truncate is actually under way.
 837          *
 838          * The intent is that i_disksize always represents the blocks which
 839          * are used by this file.  This allows recovery to restart truncate
 840          * on orphans if we crash during truncate.  We actually write i_disksize
 841          * into the on-disk inode when writing inodes out, instead of i_size.
 842          *
 843          * The only time when i_disksize and i_size may be different is when
 844          * a truncate is in progress.  The only things which change i_disksize
 845          * are ext4_get_block (growth) and ext4_truncate (shrinkth).
 846          */
 847         loff_t  i_disksize;
 848
 849         /*
 850          * i_data_sem is for serialising ext4_truncate() against
 851          * ext4_getblock().  In the 2.4 ext2 design, great chunks of inode's
 852          * data tree are chopped off during truncate. We can't do that in
 853          * ext4 because whenever we perform intermediate commits during
 854          * truncate, the inode and all the metadata blocks *must* be in a
 855          * consistent state which allows truncation of the orphans to restart
 856          * during recovery.  Hence we must fix the get_block-vs-truncate race
 857          * by other means, so we have i_data_sem.
 858          */
 859         struct rw_semaphore i_data_sem;
 860         struct inode vfs_inode;
 861         struct jbd2_inode *jinode;
 862
 863         /*
 864          * File creation time. Its function is same as that of
 865          * struct timespec i_{a,c,m}time in the generic inode.
 866          */
 867         struct timespec i_crtime;
 868
 869         /* mballoc */
 870         struct list_head i_prealloc_list;
 871         spinlock_t i_prealloc_lock;
 872
 873         /* extents status tree */
 874         struct ext4_es_tree i_es_tree;
 875         rwlock_t i_es_lock;
 876         struct list_head i_es_lru;
 877         unsigned int i_es_lru_nr;       /* protected by i_es_lock */
 878         unsigned long i_touch_when;     /* jiffies of last accessing */
 879
 880         /* ialloc */
 881         ext4_group_t    i_last_alloc_group;
 882
 883         /* allocation reservation info for delalloc */
 884         /* In case of bigalloc, these refer to clusters rather than blocks */
 885         unsigned int i_reserved_data_blocks;
 886         unsigned int i_reserved_meta_blocks;
 887         unsigned int i_allocated_meta_blocks;
 888         ext4_lblk_t i_da_metadata_calc_last_lblock;
 889         int i_da_metadata_calc_len;
 890
 891         /* on-disk additional length */
 892         __u16 i_extra_isize;
 893
 894         /* Indicate the inline data space. */
 895         u16 i_inline_off;
 896         u16 i_inline_size;
 897
 898 #ifdef CONFIG_QUOTA
 899         /* quota space reservation, managed internally by quota code */
 900         qsize_t i_reserved_quota;
 901 #endif
 902
 903         /* Lock protecting lists below */
 904         spinlock_t i_completed_io_lock;
 905         /*
 906          * Completed IOs that need unwritten extents handling and have
 907          * transaction reserved
 908          */
 909         struct list_head i_rsv_conversion_list;
 910         /*
 911          * Completed IOs that need unwritten extents handling and don't have
 912          * transaction reserved
 913          */
 914         struct list_head i_unrsv_conversion_list;
 915         atomic_t i_ioend_count; /* Number of outstanding io_end structs */
 916         atomic_t i_unwritten; /* Nr. of inflight conversions pending */
 917         struct work_struct i_rsv_conversion_work;
 918         struct work_struct i_unrsv_conversion_work;
 919
 920         spinlock_t i_block_reservation_lock;
 921
 922         /*
 923          * Transactions that contain inode's metadata needed to complete
 924          * fsync and fdatasync, respectively.
 925          */
 926         tid_t i_sync_tid;
 927         tid_t i_datasync_tid;
 928
 929         /* Precomputed uuid+inum+igen checksum for seeding inode checksums */
 930         __u32 i_csum_seed;
 931 };
 932
 933 /*
 934  * File system states
 935  */
 936 #define EXT4_VALID_FS                   0x0001  /* Unmounted cleanly */
 937 #define EXT4_ERROR_FS                   0x0002  /* Errors detected */
 938 #define EXT4_ORPHAN_FS                  0x0004  /* Orphans being recovered */
 939
 940 /*
 941  * Misc. filesystem flags
 942  */
 943 #define EXT2_FLAGS_SIGNED_HASH          0x0001  /* Signed dirhash in use */
 944 #define EXT2_FLAGS_UNSIGNED_HASH        0x0002  /* Unsigned dirhash in use */
 945 #define EXT2_FLAGS_TEST_FILESYS         0x0004  /* to test development code */
 946
 947 /*
 948  * Mount flags set via mount options or defaults
 949  */
 950 #define EXT4_MOUNT_GRPID                0x00004 /* Create files with directory's group */
 951 #define EXT4_MOUNT_DEBUG                0x00008 /* Some debugging messages */
 952 #define EXT4_MOUNT_ERRORS_CONT          0x00010 /* Continue on errors */
 953 #define EXT4_MOUNT_ERRORS_RO            0x00020 /* Remount fs ro on errors */
 954 #define EXT4_MOUNT_ERRORS_PANIC         0x00040 /* Panic on errors */
 955 #define EXT4_MOUNT_ERRORS_MASK          0x00070
 956 #define EXT4_MOUNT_MINIX_DF             0x00080 /* Mimics the Minix statfs */
 957 #define EXT4_MOUNT_NOLOAD               0x00100 /* Don't use existing journal*/
 958 #define EXT4_MOUNT_DATA_FLAGS           0x00C00 /* Mode for data writes: */
 959 #define EXT4_MOUNT_JOURNAL_DATA         0x00400 /* Write data to journal */
 960 #define EXT4_MOUNT_ORDERED_DATA         0x00800 /* Flush data before commit */
 961 #define EXT4_MOUNT_WRITEBACK_DATA       0x00C00 /* No data ordering */
 962 #define EXT4_MOUNT_UPDATE_JOURNAL       0x01000 /* Update the journal format */
 963 #define EXT4_MOUNT_NO_UID32             0x02000  /* Disable 32-bit UIDs */
 964 #define EXT4_MOUNT_XATTR_USER           0x04000 /* Extended user attributes */
 965 #define EXT4_MOUNT_POSIX_ACL            0x08000 /* POSIX Access Control Lists */
 966 #define EXT4_MOUNT_NO_AUTO_DA_ALLOC     0x10000 /* No auto delalloc mapping */
 967 #define EXT4_MOUNT_BARRIER              0x20000 /* Use block barriers */
 968 #define EXT4_MOUNT_QUOTA                0x80000 /* Some quota option set */
 969 #define EXT4_MOUNT_USRQUOTA             0x100000 /* "old" user quota */
 970 #define EXT4_MOUNT_GRPQUOTA             0x200000 /* "old" group quota */
 971 #define EXT4_MOUNT_DIOREAD_NOLOCK       0x400000 /* Enable support for dio read nolocking */
 972 #define EXT4_MOUNT_JOURNAL_CHECKSUM     0x800000 /* Journal checksums */
 973 #define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT 0x1000000 /* Journal Async Commit */
 974 #define EXT4_MOUNT_DELALLOC             0x8000000 /* Delalloc support */
 975 #define EXT4_MOUNT_DATA_ERR_ABORT       0x10000000 /* Abort on file data write */
 976 #define EXT4_MOUNT_BLOCK_VALIDITY       0x20000000 /* Block validity checking */
 977 #define EXT4_MOUNT_DISCARD              0x40000000 /* Issue DISCARD requests */
 978 #define EXT4_MOUNT_INIT_INODE_TABLE     0x80000000 /* Initialize uninitialized itables */
 979
 980 /*
 981  * Mount flags set either automatically (could not be set by mount option)
 982  * based on per file system feature or property or in special cases such as
 983  * distinguishing between explicit mount option definition and default.
 984  */
 985 #define EXT4_MOUNT2_EXPLICIT_DELALLOC   0x00000001 /* User explicitly
 986                                                       specified delalloc */
 987 #define EXT4_MOUNT2_STD_GROUP_SIZE      0x00000002 /* We have standard group
 988                                                       size of blocksize * 8
 989                                                       blocks */
 990
 991 #define clear_opt(sb, opt)              EXT4_SB(sb)->s_mount_opt &= \
 992                                                 ~EXT4_MOUNT_##opt
 993 #define set_opt(sb, opt)                EXT4_SB(sb)->s_mount_opt |= \
 994                                                 EXT4_MOUNT_##opt
 995 #define test_opt(sb, opt)               (EXT4_SB(sb)->s_mount_opt & \
 996                                          EXT4_MOUNT_##opt)
 997
 998 #define clear_opt2(sb, opt)             EXT4_SB(sb)->s_mount_opt2 &= \
 999                                                 ~EXT4_MOUNT2_##opt
1000 #define set_opt2(sb, opt)               EXT4_SB(sb)->s_mount_opt2 |= \
1001                                                 EXT4_MOUNT2_##opt
1002 #define test_opt2(sb, opt)              (EXT4_SB(sb)->s_mount_opt2 & \
1003                                          EXT4_MOUNT2_##opt)
1004
1005 #define ext4_test_and_set_bit           __test_and_set_bit_le
1006 #define ext4_set_bit                    __set_bit_le
1007 #define ext4_set_bit_atomic             ext2_set_bit_atomic
1008 #define ext4_test_and_clear_bit         __test_and_clear_bit_le
1009 #define ext4_clear_bit                  __clear_bit_le
1010 #define ext4_clear_bit_atomic           ext2_clear_bit_atomic
1011 #define ext4_test_bit                   test_bit_le
1012 #define ext4_find_next_zero_bit         find_next_zero_bit_le
1013 #define ext4_find_next_bit              find_next_bit_le
1014
1015 extern void ext4_set_bits(void *bm, int cur, int len);
1016
1017 /*
1018  * Maximal mount counts between two filesystem checks
1019  */
1020 #define EXT4_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
1021 #define EXT4_DFL_CHECKINTERVAL          0       /* Don't use interval check */
1022
1023 /*
1024  * Behaviour when detecting errors
1025  */
1026 #define EXT4_ERRORS_CONTINUE            1       /* Continue execution */
1027 #define EXT4_ERRORS_RO                  2       /* Remount fs read-only */
1028 #define EXT4_ERRORS_PANIC               3       /* Panic */
1029 #define EXT4_ERRORS_DEFAULT             EXT4_ERRORS_CONTINUE
1030
1031 /* Metadata checksum algorithm codes */
1032 #define EXT4_CRC32C_CHKSUM              1
1033
1034 /*
1035  * Structure of the super block
1036  */
1037 struct ext4_super_block {
1038 /*00*/  __le32  s_inodes_count;         /* Inodes count */
1039         __le32  s_blocks_count_lo;      /* Blocks count */
1040         __le32  s_r_blocks_count_lo;    /* Reserved blocks count */
1041         __le32  s_free_blocks_count_lo; /* Free blocks count */
1042 /*10*/  __le32  s_free_inodes_count;    /* Free inodes count */
1043         __le32  s_first_data_block;     /* First Data Block */
1044         __le32  s_log_block_size;       /* Block size */
1045         __le32  s_log_cluster_size;     /* Allocation cluster size */
1046 /*20*/  __le32  s_blocks_per_group;     /* # Blocks per group */
1047         __le32  s_clusters_per_group;   /* # Clusters per group */
1048         __le32  s_inodes_per_group;     /* # Inodes per group */
1049         __le32  s_mtime;                /* Mount time */
1050 /*30*/  __le32  s_wtime;                /* Write time */
1051         __le16  s_mnt_count;            /* Mount count */
1052         __le16  s_max_mnt_count;        /* Maximal mount count */
1053         __le16  s_magic;                /* Magic signature */
1054         __le16  s_state;                /* File system state */
1055         __le16  s_errors;               /* Behaviour when detecting errors */
1056         __le16  s_minor_rev_level;      /* minor revision level */
1057 /*40*/  __le32  s_lastcheck;            /* time of last check */
1058         __le32  s_checkinterval;        /* max. time between checks */
1059         __le32  s_creator_os;           /* OS */
1060         __le32  s_rev_level;            /* Revision level */
1061 /*50*/  __le16  s_def_resuid;           /* Default uid for reserved blocks */
1062         __le16  s_def_resgid;           /* Default gid for reserved blocks */
1063         /*
1064          * These fields are for EXT4_DYNAMIC_REV superblocks only.
1065          *
1066          * Note: the difference between the compatible feature set and
1067          * the incompatible feature set is that if there is a bit set
1068          * in the incompatible feature set that the kernel doesn't
1069          * know about, it should refuse to mount the filesystem.
1070          *
1071          * e2fsck's requirements are more strict; if it doesn't know
1072          * about a feature in either the compatible or incompatible
1073          * feature set, it must abort and not try to meddle with
1074          * things it doesn't understand...
1075          */
1076         __le32  s_first_ino;            /* First non-reserved inode */
1077         __le16  s_inode_size;           /* size of inode structure */
1078         __le16  s_block_group_nr;       /* block group # of this superblock */
1079         __le32  s_feature_compat;       /* compatible feature set */
1080 /*60*/  __le32  s_feature_incompat;     /* incompatible feature set */
1081         __le32  s_feature_ro_compat;    /* readonly-compatible feature set */
1082 /*68*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
1083 /*78*/  char    s_volume_name[16];      /* volume name */
1084 /*88*/  char    s_last_mounted[64];     /* directory where last mounted */
1085 /*C8*/  __le32  s_algorithm_usage_bitmap; /* For compression */
1086         /*
1087          * Performance hints.  Directory preallocation should only
1088          * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
1089          */
1090         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
1091         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
1092         __le16  s_reserved_gdt_blocks;  /* Per group desc for online growth */
1093         /*
1094          * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
1095          */
1096 /*D0*/  __u8    s_journal_uuid[16];     /* uuid of journal superblock */
1097 /*E0*/  __le32  s_journal_inum;         /* inode number of journal file */
1098         __le32  s_journal_dev;          /* device number of journal file */
1099         __le32  s_last_orphan;          /* start of list of inodes to delete */
1100         __le32  s_hash_seed[4];         /* HTREE hash seed */
1101         __u8    s_def_hash_version;     /* Default hash version to use */
1102         __u8    s_jnl_backup_type;
1103         __le16  s_desc_size;            /* size of group descriptor */
1104 /*100*/ __le32  s_default_mount_opts;
1105         __le32  s_first_meta_bg;        /* First metablock block group */
1106         __le32  s_mkfs_time;            /* When the filesystem was created */
1107         __le32  s_jnl_blocks[17];       /* Backup of the journal inode */
1108         /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
1109 /*150*/ __le32  s_blocks_count_hi;      /* Blocks count */
1110         __le32  s_r_blocks_count_hi;    /* Reserved blocks count */
1111         __le32  s_free_blocks_count_hi; /* Free blocks count */
1112         __le16  s_min_extra_isize;      /* All inodes have at least # bytes */
1113         __le16  s_want_extra_isize;     /* New inodes should reserve # bytes */
1114         __le32  s_flags;                /* Miscellaneous flags */
1115         __le16  s_raid_stride;          /* RAID stride */
1116         __le16  s_mmp_update_interval;  /* # seconds to wait in MMP checking */
1117         __le64  s_mmp_block;            /* Block for multi-mount protection */
1118         __le32  s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
1119         __u8    s_log_groups_per_flex;  /* FLEX_BG group size */
1120         __u8    s_checksum_type;        /* metadata checksum algorithm used */
1121         __le16  s_reserved_pad;
1122         __le64  s_kbytes_written;       /* nr of lifetime kilobytes written */
1123         __le32  s_snapshot_inum;        /* Inode number of active snapshot */
1124         __le32  s_snapshot_id;          /* sequential ID of active snapshot */
1125         __le64  s_snapshot_r_blocks_count; /* reserved blocks for active
1126                                               snapshot's future use */
1127         __le32  s_snapshot_list;        /* inode number of the head of the
1128                                            on-disk snapshot list */
1129 #define EXT4_S_ERR_START offsetof(struct ext4_super_block, s_error_count)
1130         __le32  s_error_count;          /* number of fs errors */
1131         __le32  s_first_error_time;     /* first time an error happened */
1132         __le32  s_first_error_ino;      /* inode involved in first error */
1133         __le64  s_first_error_block;    /* block involved of first error */
1134         __u8    s_first_error_func[32]; /* function where the error happened */
1135         __le32  s_first_error_line;     /* line number where error happened */
1136         __le32  s_last_error_time;      /* most recent time of an error */
1137         __le32  s_last_error_ino;       /* inode involved in last error */
1138         __le32  s_last_error_line;      /* line number where error happened */
1139         __le64  s_last_error_block;     /* block involved of last error */
1140         __u8    s_last_error_func[32];  /* function where the error happened */
1141 #define EXT4_S_ERR_END offsetof(struct ext4_super_block, s_mount_opts)
1142         __u8    s_mount_opts[64];
1143         __le32  s_usr_quota_inum;       /* inode for tracking user quota */
1144         __le32  s_grp_quota_inum;       /* inode for tracking group quota */
1145         __le32  s_overhead_clusters;    /* overhead blocks/clusters in fs */
1146         __le32  s_reserved[108];        /* Padding to the end of the block */
1147         __le32  s_checksum;             /* crc32c(superblock) */
1148 };
1149
1150 #define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
1151
1152 #ifdef __KERNEL__
1153
1154 /*
1155  * run-time mount flags
1156  */
1157 #define EXT4_MF_MNTDIR_SAMPLED  0x0001
1158 #define EXT4_MF_FS_ABORTED      0x0002  /* Fatal error detected */
1159
1160 /*
1161  * fourth extended-fs super-block data in memory
1162  */
1163 struct ext4_sb_info {
1164         unsigned long s_desc_size;      /* Size of a group descriptor in bytes */
1165         unsigned long s_inodes_per_block;/* Number of inodes per block */
1166         unsigned long s_blocks_per_group;/* Number of blocks in a group */
1167         unsigned long s_clusters_per_group; /* Number of clusters in a group */
1168         unsigned long s_inodes_per_group;/* Number of inodes in a group */
1169         unsigned long s_itb_per_group;  /* Number of inode table blocks per group */
1170         unsigned long s_gdb_count;      /* Number of group descriptor blocks */
1171         unsigned long s_desc_per_block; /* Number of group descriptors per block */
1172         ext4_group_t s_groups_count;    /* Number of groups in the fs */
1173         ext4_group_t s_blockfile_groups;/* Groups acceptable for non-extent files */
1174         unsigned long s_overhead;  /* # of fs overhead clusters */
1175         unsigned int s_cluster_ratio;   /* Number of blocks per cluster */
1176         unsigned int s_cluster_bits;    /* log2 of s_cluster_ratio */
1177         loff_t s_bitmap_maxbytes;       /* max bytes for bitmap files */
1178         struct buffer_head * s_sbh;     /* Buffer containing the super block */
1179         struct ext4_super_block *s_es;  /* Pointer to the super block in the buffer */
1180         struct buffer_head **s_group_desc;
1181         unsigned int s_mount_opt;
1182         unsigned int s_mount_opt2;
1183         unsigned int s_mount_flags;
1184         unsigned int s_def_mount_opt;
1185         ext4_fsblk_t s_sb_block;
1186         atomic64_t s_resv_clusters;
1187         kuid_t s_resuid;
1188         kgid_t s_resgid;
1189         unsigned short s_mount_state;
1190         unsigned short s_pad;
1191         int s_addr_per_block_bits;
1192         int s_desc_per_block_bits;
1193         int s_inode_size;
1194         int s_first_ino;
1195         unsigned int s_inode_readahead_blks;
1196         unsigned int s_inode_goal;
1197         spinlock_t s_next_gen_lock;
1198         u32 s_next_generation;
1199         u32 s_hash_seed[4];
1200         int s_def_hash_version;
1201         int s_hash_unsigned;    /* 3 if hash should be signed, 0 if not */
1202         struct percpu_counter s_freeclusters_counter;
1203         struct percpu_counter s_freeinodes_counter;
1204         struct percpu_counter s_dirs_counter;
1205         struct percpu_counter s_dirtyclusters_counter;
1206         struct blockgroup_lock *s_blockgroup_lock;
1207         struct proc_dir_entry *s_proc;
1208         struct kobject s_kobj;
1209         struct completion s_kobj_unregister;
1210         struct super_block *s_sb;
1211
1212         /* Journaling */
1213         struct journal_s *s_journal;
1214         struct list_head s_orphan;
1215         struct mutex s_orphan_lock;
1216         unsigned long s_resize_flags;           /* Flags indicating if there
1217                                                    is a resizer */
1218         unsigned long s_commit_interval;
1219         u32 s_max_batch_time;
1220         u32 s_min_batch_time;
1221         struct block_device *journal_bdev;
1222 #ifdef CONFIG_QUOTA
1223         char *s_qf_names[MAXQUOTAS];            /* Names of quota files with journalled quota */
1224         int s_jquota_fmt;                       /* Format of quota to use */
1225 #endif
1226         unsigned int s_want_extra_isize; /* New inodes should reserve # bytes */
1227         struct rb_root system_blks;
1228
1229 #ifdef EXTENTS_STATS
1230         /* ext4 extents stats */
1231         unsigned long s_ext_min;
1232         unsigned long s_ext_max;
1233         unsigned long s_depth_max;
1234         spinlock_t s_ext_stats_lock;
1235         unsigned long s_ext_blocks;
1236         unsigned long s_ext_extents;
1237 #endif
1238
1239         /* for buddy allocator */
1240         struct ext4_group_info ***s_group_info;
1241         struct inode *s_buddy_cache;
1242         spinlock_t s_md_lock;
1243         unsigned short *s_mb_offsets;
1244         unsigned int *s_mb_maxs;
1245         unsigned int s_group_info_size;
1246
1247         /* tunables */
1248         unsigned long s_stripe;
1249         unsigned int s_mb_stream_request;
1250         unsigned int s_mb_max_to_scan;
1251         unsigned int s_mb_min_to_scan;
1252         unsigned int s_mb_stats;
1253         unsigned int s_mb_order2_reqs;
1254         unsigned int s_mb_group_prealloc;
1255         unsigned int s_max_dir_size_kb;
1256         /* where last allocation was done - for stream allocation */
1257         unsigned long s_mb_last_group;
1258         unsigned long s_mb_last_start;
1259
1260         /* stats for buddy allocator */
1261         atomic_t s_bal_reqs;    /* number of reqs with len > 1 */
1262         atomic_t s_bal_success; /* we found long enough chunks */
1263         atomic_t s_bal_allocated;       /* in blocks */
1264         atomic_t s_bal_ex_scanned;      /* total extents scanned */
1265         atomic_t s_bal_goals;   /* goal hits */
1266         atomic_t s_bal_breaks;  /* too long searches */
1267         atomic_t s_bal_2orders; /* 2^order hits */
1268         spinlock_t s_bal_lock;
1269         unsigned long s_mb_buddies_generated;
1270         unsigned long long s_mb_generation_time;
1271         atomic_t s_mb_lost_chunks;
1272         atomic_t s_mb_preallocated;
1273         atomic_t s_mb_discarded;
1274         atomic_t s_lock_busy;
1275
1276         /* locality groups */
1277         struct ext4_locality_group __percpu *s_locality_groups;
1278
1279         /* for write statistics */
1280         unsigned long s_sectors_written_start;
1281         u64 s_kbytes_written;
1282
1283         /* the size of zero-out chunk */
1284         unsigned int s_extent_max_zeroout_kb;
1285
1286         unsigned int s_log_groups_per_flex;
1287         struct flex_groups *s_flex_groups;
1288         ext4_group_t s_flex_groups_allocated;
1289
1290         /* workqueue for unreserved extent convertions (dio) */
1291         struct workqueue_struct *unrsv_conversion_wq;
1292         /* workqueue for reserved extent conversions (buffered io) */
1293         struct workqueue_struct *rsv_conversion_wq;
1294
1295         /* timer for periodic error stats printing */
1296         struct timer_list s_err_report;
1297
1298         /* Lazy inode table initialization info */
1299         struct ext4_li_request *s_li_request;
1300         /* Wait multiplier for lazy initialization thread */
1301         unsigned int s_li_wait_mult;
1302
1303         /* Kernel thread for multiple mount protection */
1304         struct task_struct *s_mmp_tsk;
1305
1306         /* record the last minlen when FITRIM is called. */
1307         atomic_t s_last_trim_minblks;
1308
1309         /* Reference to checksum algorithm driver via cryptoapi */
1310         struct crypto_shash *s_chksum_driver;
1311
1312         /* Precomputed FS UUID checksum for seeding other checksums */
1313         __u32 s_csum_seed;
1314
1315         /* Reclaim extents from extent status tree */
1316         struct shrinker s_es_shrinker;
1317         struct list_head s_es_lru;
1318         unsigned long s_es_last_sorted;
1319         struct percpu_counter s_extent_cache_cnt;
1320         spinlock_t s_es_lru_lock ____cacheline_aligned_in_smp;
1321 };
1322
1323 static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
1324 {
1325         return sb->s_fs_info;
1326 }
1327 static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
1328 {
1329         return container_of(inode, struct ext4_inode_info, vfs_inode);
1330 }
1331
1332 static inline struct timespec ext4_current_time(struct inode *inode)
1333 {
1334         return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
1335                 current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
1336 }
1337
1338 static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
1339 {
1340         return ino == EXT4_ROOT_INO ||
1341                 ino == EXT4_USR_QUOTA_INO ||
1342                 ino == EXT4_GRP_QUOTA_INO ||
1343                 ino == EXT4_BOOT_LOADER_INO ||
1344                 ino == EXT4_JOURNAL_INO ||
1345                 ino == EXT4_RESIZE_INO ||
1346                 (ino >= EXT4_FIRST_INO(sb) &&
1347                  ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
1348 }
1349
1350 static inline void ext4_set_io_unwritten_flag(struct inode *inode,
1351                                               struct ext4_io_end *io_end)
1352 {
1353         if (!(io_end->flag & EXT4_IO_END_UNWRITTEN)) {
1354                 /* Writeback has to have coversion transaction reserved */
1355                 WARN_ON(EXT4_SB(inode->i_sb)->s_journal && !io_end->handle &&
1356                         !(io_end->flag & EXT4_IO_END_DIRECT));
1357                 io_end->flag |= EXT4_IO_END_UNWRITTEN;
1358                 atomic_inc(&EXT4_I(inode)->i_unwritten);
1359         }
1360 }
1361
1362 static inline ext4_io_end_t *ext4_inode_aio(struct inode *inode)
1363 {
1364         return inode->i_private;
1365 }
1366
1367 static inline void ext4_inode_aio_set(struct inode *inode, ext4_io_end_t *io)
1368 {
1369         inode->i_private = io;
1370 }
1371
1372 /*
1373  * Inode dynamic state flags
1374  */
1375 enum {
1376         EXT4_STATE_JDATA,               /* journaled data exists */
1377         EXT4_STATE_NEW,                 /* inode is newly created */
1378         EXT4_STATE_XATTR,               /* has in-inode xattrs */
1379         EXT4_STATE_NO_EXPAND,           /* No space for expansion */
1380         EXT4_STATE_DA_ALLOC_CLOSE,      /* Alloc DA blks on close */
1381         EXT4_STATE_EXT_MIGRATE,         /* Inode is migrating */
1382         EXT4_STATE_DIO_UNWRITTEN,       /* need convert on dio done*/
1383         EXT4_STATE_NEWENTRY,            /* File just added to dir */
1384         EXT4_STATE_DELALLOC_RESERVED,   /* blks already reserved for delalloc */
1385         EXT4_STATE_DIOREAD_LOCK,        /* Disable support for dio read
1386                                            nolocking */
1387         EXT4_STATE_MAY_INLINE_DATA,     /* may have in-inode data */
1388         EXT4_STATE_ORDERED_MODE,        /* data=ordered mode */
1389 };
1390
1391 #define EXT4_INODE_BIT_FNS(name, field, offset)                         \
1392 static inline int ext4_test_inode_##name(struct inode *inode, int bit)  \
1393 {                                                                       \
1394         return test_bit(bit + (offset), &EXT4_I(inode)->i_##field);     \
1395 }                                                                       \
1396 static inline void ext4_set_inode_##name(struct inode *inode, int bit)  \
1397 {                                                                       \
1398         set_bit(bit + (offset), &EXT4_I(inode)->i_##field);             \
1399 }                                                                       \
1400 static inline void ext4_clear_inode_##name(struct inode *inode, int bit) \
1401 {                                                                       \
1402         clear_bit(bit + (offset), &EXT4_I(inode)->i_##field);           \
1403 }
1404
1405 EXT4_INODE_BIT_FNS(flag, flags, 0)
1406 #if (BITS_PER_LONG < 64)
1407 EXT4_INODE_BIT_FNS(state, state_flags, 0)
1408
1409 static inline void ext4_clear_state_flags(struct ext4_inode_info *ei)
1410 {
1411         (ei)->i_state_flags = 0;
1412 }
1413 #else
1414 EXT4_INODE_BIT_FNS(state, flags, 32)
1415
1416 static inline void ext4_clear_state_flags(struct ext4_inode_info *ei)
1417 {
1418         /* We depend on the fact that callers will set i_flags */
1419 }
1420 #endif
1421 #else
1422 /* Assume that user mode programs are passing in an ext4fs superblock, not
1423  * a kernel struct super_block.  This will allow us to call the feature-test
1424  * macros from user land. */
1425 #define EXT4_SB(sb)     (sb)
1426 #endif
1427
1428 #define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
1429
1430 /*
1431  * Codes for operating systems
1432  */
1433 #define EXT4_OS_LINUX           0
1434 #define EXT4_OS_HURD            1
1435 #define EXT4_OS_MASIX           2
1436 #define EXT4_OS_FREEBSD         3
1437 #define EXT4_OS_LITES           4
1438
1439 /*
1440  * Revision levels
1441  */
1442 #define EXT4_GOOD_OLD_REV       0       /* The good old (original) format */
1443 #define EXT4_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
1444
1445 #define EXT4_CURRENT_REV        EXT4_GOOD_OLD_REV
1446 #define EXT4_MAX_SUPP_REV       EXT4_DYNAMIC_REV
1447
1448 #define EXT4_GOOD_OLD_INODE_SIZE 128
1449
1450 /*
1451  * Feature set definitions
1452  */
1453
1454 #define EXT4_HAS_COMPAT_FEATURE(sb,mask)                        \
1455         ((EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask)) != 0)
1456 #define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask)                     \
1457         ((EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask)) != 0)
1458 #define EXT4_HAS_INCOMPAT_FEATURE(sb,mask)                      \
1459         ((EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask)) != 0)
1460 #define EXT4_SET_COMPAT_FEATURE(sb,mask)                        \
1461         EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
1462 #define EXT4_SET_RO_COMPAT_FEATURE(sb,mask)                     \
1463         EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
1464 #define EXT4_SET_INCOMPAT_FEATURE(sb,mask)                      \
1465         EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
1466 #define EXT4_CLEAR_COMPAT_FEATURE(sb,mask)                      \
1467         EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
1468 #define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask)                   \
1469         EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
1470 #define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask)                    \
1471         EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
1472
1473 #define EXT4_FEATURE_COMPAT_DIR_PREALLOC        0x0001
1474 #define EXT4_FEATURE_COMPAT_IMAGIC_INODES       0x0002
1475 #define EXT4_FEATURE_COMPAT_HAS_JOURNAL         0x0004
1476 #define EXT4_FEATURE_COMPAT_EXT_ATTR            0x0008
1477 #define EXT4_FEATURE_COMPAT_RESIZE_INODE        0x0010
1478 #define EXT4_FEATURE_COMPAT_DIR_INDEX           0x0020
1479
1480 #define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
1481 #define EXT4_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
1482 #define EXT4_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
1483 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
1484 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM         0x0010
1485 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK        0x0020
1486 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE      0x0040
1487 #define EXT4_FEATURE_RO_COMPAT_QUOTA            0x0100
1488 #define EXT4_FEATURE_RO_COMPAT_BIGALLOC         0x0200
1489 /*
1490  * METADATA_CSUM also enables group descriptor checksums (GDT_CSUM).  When
1491  * METADATA_CSUM is set, group descriptor checksums use the same algorithm as
1492  * all other data structures' checksums.  However, the METADATA_CSUM and
1493  * GDT_CSUM bits are mutually exclusive.
1494  */
1495 #define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM    0x0400
1496
1497 #define EXT4_FEATURE_INCOMPAT_COMPRESSION       0x0001
1498 #define EXT4_FEATURE_INCOMPAT_FILETYPE          0x0002
1499 #define EXT4_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
1500 #define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
1501 #define EXT4_FEATURE_INCOMPAT_META_BG           0x0010
1502 #define EXT4_FEATURE_INCOMPAT_EXTENTS           0x0040 /* extents support */
1503 #define EXT4_FEATURE_INCOMPAT_64BIT             0x0080
1504 #define EXT4_FEATURE_INCOMPAT_MMP               0x0100
1505 #define EXT4_FEATURE_INCOMPAT_FLEX_BG           0x0200
1506 #define EXT4_FEATURE_INCOMPAT_EA_INODE          0x0400 /* EA in inode */
1507 #define EXT4_FEATURE_INCOMPAT_DIRDATA           0x1000 /* data in dirent */
1508 #define EXT4_FEATURE_INCOMPAT_BG_USE_META_CSUM  0x2000 /* use crc32c for bg */
1509 #define EXT4_FEATURE_INCOMPAT_LARGEDIR          0x4000 /* >2GB or 3-lvl htree */
1510 #define EXT4_FEATURE_INCOMPAT_INLINE_DATA       0x8000 /* data in inode */
1511
1512 #define EXT2_FEATURE_COMPAT_SUPP        EXT4_FEATURE_COMPAT_EXT_ATTR
1513 #define EXT2_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
1514                                          EXT4_FEATURE_INCOMPAT_META_BG)
1515 #define EXT2_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
1516                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
1517                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
1518
1519 #define EXT3_FEATURE_COMPAT_SUPP        EXT4_FEATURE_COMPAT_EXT_ATTR
1520 #define EXT3_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
1521                                          EXT4_FEATURE_INCOMPAT_RECOVER| \
1522                                          EXT4_FEATURE_INCOMPAT_META_BG)
1523 #define EXT3_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
1524                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
1525                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
1526
1527 #define EXT4_FEATURE_COMPAT_SUPP        EXT2_FEATURE_COMPAT_EXT_ATTR
1528 #define EXT4_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
1529                                          EXT4_FEATURE_INCOMPAT_RECOVER| \
1530                                          EXT4_FEATURE_INCOMPAT_META_BG| \
1531                                          EXT4_FEATURE_INCOMPAT_EXTENTS| \
1532                                          EXT4_FEATURE_INCOMPAT_64BIT| \
1533                                          EXT4_FEATURE_INCOMPAT_FLEX_BG| \
1534                                          EXT4_FEATURE_INCOMPAT_MMP |    \
1535                                          EXT4_FEATURE_INCOMPAT_INLINE_DATA)
1536 #define EXT4_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
1537                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
1538                                          EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
1539                                          EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
1540                                          EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
1541                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
1542                                          EXT4_FEATURE_RO_COMPAT_HUGE_FILE |\
1543                                          EXT4_FEATURE_RO_COMPAT_BIGALLOC |\
1544                                          EXT4_FEATURE_RO_COMPAT_METADATA_CSUM|\
1545                                          EXT4_FEATURE_RO_COMPAT_QUOTA)
1546
1547 /*
1548  * Default values for user and/or group using reserved blocks
1549  */
1550 #define EXT4_DEF_RESUID         0
1551 #define EXT4_DEF_RESGID         0
1552
1553 #define EXT4_DEF_INODE_READAHEAD_BLKS   32
1554
1555 /*
1556  * Default mount options
1557  */
1558 #define EXT4_DEFM_DEBUG         0x0001
1559 #define EXT4_DEFM_BSDGROUPS     0x0002
1560 #define EXT4_DEFM_XATTR_USER    0x0004
1561 #define EXT4_DEFM_ACL           0x0008
1562 #define EXT4_DEFM_UID16         0x0010
1563 #define EXT4_DEFM_JMODE         0x0060
1564 #define EXT4_DEFM_JMODE_DATA    0x0020
1565 #define EXT4_DEFM_JMODE_ORDERED 0x0040
1566 #define EXT4_DEFM_JMODE_WBACK   0x0060
1567 #define EXT4_DEFM_NOBARRIER     0x0100
1568 #define EXT4_DEFM_BLOCK_VALIDITY 0x0200
1569 #define EXT4_DEFM_DISCARD       0x0400
1570 #define EXT4_DEFM_NODELALLOC    0x0800
1571
1572 /*
1573  * Default journal batch times
1574  */
1575 #define EXT4_DEF_MIN_BATCH_TIME 0
1576 #define EXT4_DEF_MAX_BATCH_TIME 15000 /* 15ms */
1577
1578 /*
1579  * Minimum number of groups in a flexgroup before we separate out
1580  * directories into the first block group of a flexgroup
1581  */
1582 #define EXT4_FLEX_SIZE_DIR_ALLOC_SCHEME 4
1583
1584 /*
1585  * Structure of a directory entry
1586  */
1587 #define EXT4_NAME_LEN 255
1588
1589 struct ext4_dir_entry {
1590         __le32  inode;                  /* Inode number */
1591         __le16  rec_len;                /* Directory entry length */
1592         __le16  name_len;               /* Name length */
1593         char    name[EXT4_NAME_LEN];    /* File name */
1594 };
1595
1596 /*
1597  * The new version of the directory entry.  Since EXT4 structures are
1598  * stored in intel byte order, and the name_len field could never be
1599  * bigger than 255 chars, it's safe to reclaim the extra byte for the
1600  * file_type field.
1601  */
1602 struct ext4_dir_entry_2 {
1603         __le32  inode;                  /* Inode number */
1604         __le16  rec_len;                /* Directory entry length */
1605         __u8    name_len;               /* Name length */
1606         __u8    file_type;
1607         char    name[EXT4_NAME_LEN];    /* File name */
1608 };
1609
1610 /*
1611  * This is a bogus directory entry at the end of each leaf block that
1612  * records checksums.
1613  */
1614 struct ext4_dir_entry_tail {
1615         __le32  det_reserved_zero1;     /* Pretend to be unused */
1616         __le16  det_rec_len;            /* 12 */
1617         __u8    det_reserved_zero2;     /* Zero name length */
1618         __u8    det_reserved_ft;        /* 0xDE, fake file type */
1619         __le32  det_checksum;           /* crc32c(uuid+inum+dirblock) */
1620 };
1621
1622 #define EXT4_DIRENT_TAIL(block, blocksize) \
1623         ((struct ext4_dir_entry_tail *)(((void *)(block)) + \
1624                                         ((blocksize) - \
1625                                          sizeof(struct ext4_dir_entry_tail))))
1626
1627 /*
1628  * Ext4 directory file types.  Only the low 3 bits are used.  The
1629  * other bits are reserved for now.
1630  */
1631 #define EXT4_FT_UNKNOWN         0
1632 #define EXT4_FT_REG_FILE        1
1633 #define EXT4_FT_DIR             2
1634 #define EXT4_FT_CHRDEV          3
1635 #define EXT4_FT_BLKDEV          4
1636 #define EXT4_FT_FIFO            5
1637 #define EXT4_FT_SOCK            6
1638 #define EXT4_FT_SYMLINK         7
1639
1640 #define EXT4_FT_MAX             8
1641
1642 #define EXT4_FT_DIR_CSUM        0xDE
1643
1644 /*
1645  * EXT4_DIR_PAD defines the directory entries boundaries
1646  *
1647  * NOTE: It must be a multiple of 4
1648  */
1649 #define EXT4_DIR_PAD                    4
1650 #define EXT4_DIR_ROUND                  (EXT4_DIR_PAD - 1)
1651 #define EXT4_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT4_DIR_ROUND) & \
1652                                          ~EXT4_DIR_ROUND)
1653 #define EXT4_MAX_REC_LEN                ((1<<16)-1)
1654
1655 /*
1656  * If we ever get support for fs block sizes > page_size, we'll need
1657  * to remove the #if statements in the next two functions...
1658  */
1659 static inline unsigned int
1660 ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize)
1661 {
1662         unsigned len = le16_to_cpu(dlen);
1663
1664 #if (PAGE_CACHE_SIZE >= 65536)
1665         if (len == EXT4_MAX_REC_LEN || len == 0)
1666                 return blocksize;
1667         return (len & 65532) | ((len & 3) << 16);
1668 #else
1669         return len;
1670 #endif
1671 }
1672
1673 static inline __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize)
1674 {
1675         if ((len > blocksize) || (blocksize > (1 << 18)) || (len & 3))
1676                 BUG();
1677 #if (PAGE_CACHE_SIZE >= 65536)
1678         if (len < 65536)
1679                 return cpu_to_le16(len);
1680         if (len == blocksize) {
1681                 if (blocksize == 65536)
1682                         return cpu_to_le16(EXT4_MAX_REC_LEN);
1683                 else
1684                         return cpu_to_le16(0);
1685         }
1686         return cpu_to_le16((len & 65532) | ((len >> 16) & 3));
1687 #else
1688         return cpu_to_le16(len);
1689 #endif
1690 }
1691
1692 /*
1693  * Hash Tree Directory indexing
1694  * (c) Daniel Phillips, 2001
1695  */
1696
1697 #define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
1698                                       EXT4_FEATURE_COMPAT_DIR_INDEX) && \
1699                     ext4_test_inode_flag((dir), EXT4_INODE_INDEX))
1700 #define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
1701 #define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
1702
1703 /* Legal values for the dx_root hash_version field: */
1704
1705 #define DX_HASH_LEGACY          0
1706 #define DX_HASH_HALF_MD4        1
1707 #define DX_HASH_TEA             2
1708 #define DX_HASH_LEGACY_UNSIGNED 3
1709 #define DX_HASH_HALF_MD4_UNSIGNED       4
1710 #define DX_HASH_TEA_UNSIGNED            5
1711
1712 static inline u32 ext4_chksum(struct ext4_sb_info *sbi, u32 crc,
1713                               const void *address, unsigned int length)
1714 {
1715         struct {
1716                 struct shash_desc shash;
1717                 char ctx[4];
1718         } desc;
1719         int err;
1720
1721         BUG_ON(crypto_shash_descsize(sbi->s_chksum_driver)!=sizeof(desc.ctx));
1722
1723         desc.shash.tfm = sbi->s_chksum_driver;
1724         desc.shash.flags = 0;
1725         *(u32 *)desc.ctx = crc;
1726
1727         err = crypto_shash_update(&desc.shash, address, length);
1728         BUG_ON(err);
1729
1730         return *(u32 *)desc.ctx;
1731 }
1732
1733 #ifdef __KERNEL__
1734
1735 /* hash info structure used by the directory hash */
1736 struct dx_hash_info
1737 {
1738         u32             hash;
1739         u32             minor_hash;
1740         int             hash_version;
1741         u32             *seed;
1742 };
1743
1744
1745 /* 32 and 64 bit signed EOF for dx directories */
1746 #define EXT4_HTREE_EOF_32BIT   ((1UL  << (32 - 1)) - 1)
1747 #define EXT4_HTREE_EOF_64BIT   ((1ULL << (64 - 1)) - 1)
1748
1749
1750 /*
1751  * Control parameters used by ext4_htree_next_block
1752  */
1753 #define HASH_NB_ALWAYS          1
1754
1755
1756 /*
1757  * Describe an inode's exact location on disk and in memory
1758  */
1759 struct ext4_iloc
1760 {
1761         struct buffer_head *bh;
1762         unsigned long offset;
1763         ext4_group_t block_group;
1764 };
1765
1766 static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
1767 {
1768         return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
1769 }
1770
1771 /*
1772  * This structure is stuffed into the struct file's private_data field
1773  * for directories.  It is where we put information so that we can do
1774  * readdir operations in hash tree order.
1775  */
1776 struct dir_private_info {
1777         struct rb_root  root;
1778         struct rb_node  *curr_node;
1779         struct fname    *extra_fname;
1780         loff_t          last_pos;
1781         __u32           curr_hash;
1782         __u32           curr_minor_hash;
1783         __u32           next_hash;
1784 };
1785
1786 /* calculate the first block number of the group */
1787 static inline ext4_fsblk_t
1788 ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
1789 {
1790         return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
1791                 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
1792 }
1793
1794 /*
1795  * Special error return code only used by dx_probe() and its callers.
1796  */
1797 #define ERR_BAD_DX_DIR  -75000
1798
1799 /*
1800  * Timeout and state flag for lazy initialization inode thread.
1801  */
1802 #define EXT4_DEF_LI_WAIT_MULT                   10
1803 #define EXT4_DEF_LI_MAX_START_DELAY             5
1804 #define EXT4_LAZYINIT_QUIT                      0x0001
1805 #define EXT4_LAZYINIT_RUNNING                   0x0002
1806
1807 /*
1808  * Lazy inode table initialization info
1809  */
1810 struct ext4_lazy_init {
1811         unsigned long           li_state;
1812         struct list_head        li_request_list;
1813         struct mutex            li_list_mtx;
1814 };
1815
1816 struct ext4_li_request {
1817         struct super_block      *lr_super;
1818         struct ext4_sb_info     *lr_sbi;
1819         ext4_group_t            lr_next_group;
1820         struct list_head        lr_request;
1821         unsigned long           lr_next_sched;
1822         unsigned long           lr_timeout;
1823 };
1824
1825 struct ext4_features {
1826         struct kobject f_kobj;
1827         struct completion f_kobj_unregister;
1828 };
1829
1830 /*
1831  * This structure will be used for multiple mount protection. It will be
1832  * written into the block number saved in the s_mmp_block field in the
1833  * superblock. Programs that check MMP should assume that if
1834  * SEQ_FSCK (or any unknown code above SEQ_MAX) is present then it is NOT safe
1835  * to use the filesystem, regardless of how old the timestamp is.
1836  */
1837 #define EXT4_MMP_MAGIC     0x004D4D50U /* ASCII for MMP */
1838 #define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
1839 #define EXT4_MMP_SEQ_FSCK  0xE24D4D50U /* mmp_seq value when being fscked */
1840 #define EXT4_MMP_SEQ_MAX   0xE24D4D4FU /* maximum valid mmp_seq value */
1841
1842 struct mmp_struct {
1843         __le32  mmp_magic;              /* Magic number for MMP */
1844         __le32  mmp_seq;                /* Sequence no. updated periodically */
1845
1846         /*
1847          * mmp_time, mmp_nodename & mmp_bdevname are only used for information
1848          * purposes and do not affect the correctness of the algorithm
1849          */
1850         __le64  mmp_time;               /* Time last updated */
1851         char    mmp_nodename[64];       /* Node which last updated MMP block */
1852         char    mmp_bdevname[32];       /* Bdev which last updated MMP block */
1853
1854         /*
1855          * mmp_check_interval is used to verify if the MMP block has been
1856          * updated on the block device. The value is updated based on the
1857          * maximum time to write the MMP block during an update cycle.
1858          */
1859         __le16  mmp_check_interval;
1860
1861         __le16  mmp_pad1;
1862         __le32  mmp_pad2[226];
1863         __le32  mmp_checksum;           /* crc32c(uuid+mmp_block) */
1864 };
1865
1866 /* arguments passed to the mmp thread */
1867 struct mmpd_data {
1868         struct buffer_head *bh; /* bh from initial read_mmp_block() */
1869         struct super_block *sb;  /* super block of the fs */
1870 };
1871
1872 /*
1873  * Check interval multiplier
1874  * The MMP block is written every update interval and initially checked every
1875  * update interval x the multiplier (the value is then adapted based on the
1876  * write latency). The reason is that writes can be delayed under load and we
1877  * don't want readers to incorrectly assume that the filesystem is no longer
1878  * in use.
1879  */
1880 #define EXT4_MMP_CHECK_MULT             2UL
1881
1882 /*
1883  * Minimum interval for MMP checking in seconds.
1884  */
1885 #define EXT4_MMP_MIN_CHECK_INTERVAL     5UL
1886
1887 /*
1888  * Maximum interval for MMP checking in seconds.
1889  */
1890 #define EXT4_MMP_MAX_CHECK_INTERVAL     300UL
1891
1892 /*
1893  * Function prototypes
1894  */
1895
1896 /*
1897  * Ok, these declarations are also in <linux/kernel.h> but none of the
1898  * ext4 source programs needs to include it so they are duplicated here.
1899  */
1900 # define NORET_TYPE     /**/
1901 # define ATTRIB_NORET   __attribute__((noreturn))
1902 # define NORET_AND      noreturn,
1903
1904 /* bitmap.c */
1905 extern unsigned int ext4_count_free(char *bitmap, unsigned numchars);
1906 void ext4_inode_bitmap_csum_set(struct super_block *sb, ext4_group_t group,
1907                                 struct ext4_group_desc *gdp,
1908                                 struct buffer_head *bh, int sz);
1909 int ext4_inode_bitmap_csum_verify(struct super_block *sb, ext4_group_t group,
1910                                   struct ext4_group_desc *gdp,
1911                                   struct buffer_head *bh, int sz);
1912 void ext4_block_bitmap_csum_set(struct super_block *sb, ext4_group_t group,
1913                                 struct ext4_group_desc *gdp,
1914                                 struct buffer_head *bh);
1915 int ext4_block_bitmap_csum_verify(struct super_block *sb, ext4_group_t group,
1916                                   struct ext4_group_desc *gdp,
1917                                   struct buffer_head *bh);
1918
1919 /* balloc.c */
1920 extern void ext4_get_group_no_and_offset(struct super_block *sb,
1921                                          ext4_fsblk_t blocknr,
1922                                          ext4_group_t *blockgrpp,
1923                                          ext4_grpblk_t *offsetp);
1924 extern ext4_group_t ext4_get_group_number(struct super_block *sb,
1925                                           ext4_fsblk_t block);
1926
1927 extern void ext4_validate_block_bitmap(struct super_block *sb,
1928                                        struct ext4_group_desc *desc,
1929                                        unsigned int block_group,
1930                                        struct buffer_head *bh);
1931 extern unsigned int ext4_block_group(struct super_block *sb,
1932                         ext4_fsblk_t blocknr);
1933 extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
1934                         ext4_fsblk_t blocknr);
1935 extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
1936 extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
1937                         ext4_group_t group);
1938 extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
1939                                          ext4_fsblk_t goal,
1940                                          unsigned int flags,
1941                                          unsigned long *count,
1942                                          int *errp);
1943 extern int ext4_claim_free_clusters(struct ext4_sb_info *sbi,
1944                                     s64 nclusters, unsigned int flags);
1945 extern ext4_fsblk_t ext4_count_free_clusters(struct super_block *);
1946 extern void ext4_check_blocks_bitmap(struct super_block *);
1947 extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
1948                                                     ext4_group_t block_group,
1949                                                     struct buffer_head ** bh);
1950 extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
1951
1952 extern struct buffer_head *ext4_read_block_bitmap_nowait(struct super_block *sb,
1953                                                 ext4_group_t block_group);
1954 extern int ext4_wait_block_bitmap(struct super_block *sb,
1955                                   ext4_group_t block_group,
1956                                   struct buffer_head *bh);
1957 extern struct buffer_head *ext4_read_block_bitmap(struct super_block *sb,
1958                                                   ext4_group_t block_group);
1959 extern void ext4_init_block_bitmap(struct super_block *sb,
1960                                    struct buffer_head *bh,
1961                                    ext4_group_t group,
1962                                    struct ext4_group_desc *desc);
1963 extern unsigned ext4_free_clusters_after_init(struct super_block *sb,
1964                                               ext4_group_t block_group,
1965                                               struct ext4_group_desc *gdp);
1966 extern unsigned ext4_num_overhead_clusters(struct super_block *sb,
1967                                            ext4_group_t block_group,
1968                                            struct ext4_group_desc *gdp);
1969 ext4_fsblk_t ext4_inode_to_goal_block(struct inode *);
1970
1971 /* dir.c */
1972 extern int __ext4_check_dir_entry(const char *, unsigned int, struct inode *,
1973                                   struct file *,
1974                                   struct ext4_dir_entry_2 *,
1975                                   struct buffer_head *, char *, int,
1976                                   unsigned int);
1977 #define ext4_check_dir_entry(dir, filp, de, bh, buf, size, offset)      \
1978         unlikely(__ext4_check_dir_entry(__func__, __LINE__, (dir), (filp), \
1979                                         (de), (bh), (buf), (size), (offset)))
1980 extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
1981                                     __u32 minor_hash,
1982                                     struct ext4_dir_entry_2 *dirent);
1983 extern void ext4_htree_free_dir_info(struct dir_private_info *p);
1984 extern int ext4_find_dest_de(struct inode *dir, struct inode *inode,
1985                              struct buffer_head *bh,
1986                              void *buf, int buf_size,
1987                              const char *name, int namelen,
1988                              struct ext4_dir_entry_2 **dest_de);
1989 void ext4_insert_dentry(struct inode *inode,
1990                         struct ext4_dir_entry_2 *de,
1991                         int buf_size,
1992                         const char *name, int namelen);
1993 static inline void ext4_update_dx_flag(struct inode *inode)
1994 {
1995         if (!EXT4_HAS_COMPAT_FEATURE(inode->i_sb,
1996                                      EXT4_FEATURE_COMPAT_DIR_INDEX))
1997                 ext4_clear_inode_flag(inode, EXT4_INODE_INDEX);
1998 }
1999 static unsigned char ext4_filetype_table[] = {
2000         DT_UNKNOWN, DT_REG, DT_DIR, DT_CHR, DT_BLK, DT_FIFO, DT_SOCK, DT_LNK
2001 };
2002
2003 static inline  unsigned char get_dtype(struct super_block *sb, int filetype)
2004 {
2005         if (!EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_FILETYPE) ||
2006             (filetype >= EXT4_FT_MAX))
2007                 return DT_UNKNOWN;
2008
2009         return ext4_filetype_table[filetype];
2010 }
2011
2012 /* fsync.c */
2013 extern int ext4_sync_file(struct file *, loff_t, loff_t, int);
2014
2015 /* hash.c */
2016 extern int ext4fs_dirhash(const char *name, int len, struct
2017                           dx_hash_info *hinfo);
2018
2019 /* ialloc.c */
2020 extern struct inode *__ext4_new_inode(handle_t *, struct inode *, umode_t,
2021                                       const struct qstr *qstr, __u32 goal,
2022                                       uid_t *owner, int handle_type,
2023                                       unsigned int line_no, int nblocks);
2024
2025 #define ext4_new_inode(handle, dir, mode, qstr, goal, owner) \
2026         __ext4_new_inode((handle), (dir), (mode), (qstr), (goal), (owner), \
2027                          0, 0, 0)
2028 #define ext4_new_inode_start_handle(dir, mode, qstr, goal, owner, \
2029                                     type, nblocks)                  \
2030         __ext4_new_inode(NULL, (dir), (mode), (qstr), (goal), (owner), \
2031                          (type), __LINE__, (nblocks))
2032
2033
2034 extern void ext4_free_inode(handle_t *, struct inode *);
2035 extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
2036 extern unsigned long ext4_count_free_inodes(struct super_block *);
2037 extern unsigned long ext4_count_dirs(struct super_block *);
2038 extern void ext4_check_inodes_bitmap(struct super_block *);
2039 extern void ext4_mark_bitmap_end(int start_bit, int end_bit, char *bitmap);
2040 extern int ext4_init_inode_table(struct super_block *sb,
2041                                  ext4_group_t group, int barrier);
2042 extern void ext4_end_bitmap_read(struct buffer_head *bh, int uptodate);
2043
2044 /* mballoc.c */
2045 extern long ext4_mb_stats;
2046 extern long ext4_mb_max_to_scan;
2047 extern int ext4_mb_init(struct super_block *);
2048 extern int ext4_mb_release(struct super_block *);
2049 extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
2050                                 struct ext4_allocation_request *, int *);
2051 extern int ext4_mb_reserve_blocks(struct super_block *, int);
2052 extern void ext4_discard_preallocations(struct inode *);
2053 extern int __init ext4_init_mballoc(void);
2054 extern void ext4_exit_mballoc(void);
2055 extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
2056                              struct buffer_head *bh, ext4_fsblk_t block,
2057                              unsigned long count, int flags);
2058 extern int ext4_mb_alloc_groupinfo(struct super_block *sb,
2059                                    ext4_group_t ngroups);
2060 extern int ext4_mb_add_groupinfo(struct super_block *sb,
2061                 ext4_group_t i, struct ext4_group_desc *desc);
2062 extern int ext4_group_add_blocks(handle_t *handle, struct super_block *sb,
2063                                 ext4_fsblk_t block, unsigned long count);
2064 extern int ext4_trim_fs(struct super_block *, struct fstrim_range *);
2065
2066 /* inode.c */
2067 struct buffer_head *ext4_getblk(handle_t *, struct inode *,
2068                                                 ext4_lblk_t, int, int *);
2069 struct buffer_head *ext4_bread(handle_t *, struct inode *,
2070                                                 ext4_lblk_t, int, int *);
2071 int ext4_get_block_write(struct inode *inode, sector_t iblock,
2072                          struct buffer_head *bh_result, int create);
2073 int ext4_get_block(struct inode *inode, sector_t iblock,
2074                                 struct buffer_head *bh_result, int create);
2075 int ext4_da_get_block_prep(struct inode *inode, sector_t iblock,
2076                            struct buffer_head *bh, int create);
2077 int ext4_walk_page_buffers(handle_t *handle,
2078                            struct buffer_head *head,
2079                            unsigned from,
2080                            unsigned to,
2081                            int *partial,
2082                            int (*fn)(handle_t *handle,
2083                                      struct buffer_head *bh));
2084 int do_journal_get_write_access(handle_t *handle,
2085                                 struct buffer_head *bh);
2086 #define FALL_BACK_TO_NONDELALLOC 1
2087 #define CONVERT_INLINE_DATA      2
2088
2089 extern struct inode *ext4_iget(struct super_block *, unsigned long);
2090 extern int  ext4_write_inode(struct inode *, struct writeback_control *);
2091 extern int  ext4_setattr(struct dentry *, struct iattr *);
2092 extern int  ext4_getattr(struct vfsmount *mnt, struct dentry *dentry,
2093                                 struct kstat *stat);
2094 extern void ext4_evict_inode(struct inode *);
2095 extern void ext4_clear_inode(struct inode *);
2096 extern int  ext4_sync_inode(handle_t *, struct inode *);
2097 extern void ext4_dirty_inode(struct inode *, int);
2098 extern int ext4_change_inode_journal_flag(struct inode *, int);
2099 extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
2100 extern int ext4_inode_attach_jinode(struct inode *inode);
2101 extern int ext4_can_truncate(struct inode *inode);
2102 extern void ext4_truncate(struct inode *);
2103 extern int ext4_punch_hole(struct inode *inode, loff_t offset, loff_t length);
2104 extern int ext4_truncate_restart_trans(handle_t *, struct inode *, int nblocks);
2105 extern void ext4_set_inode_flags(struct inode *);
2106 extern void ext4_get_inode_flags(struct ext4_inode_info *);
2107 extern int ext4_alloc_da_blocks(struct inode *inode);
2108 extern void ext4_set_aops(struct inode *inode);
2109 extern int ext4_writepage_trans_blocks(struct inode *);
2110 extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
2111 extern int ext4_block_truncate_page(handle_t *handle,
2112                 struct address_space *mapping, loff_t from);
2113 extern int ext4_block_zero_page_range(handle_t *handle,
2114                 struct address_space *mapping, loff_t from, loff_t length);
2115 extern int ext4_zero_partial_blocks(handle_t *handle, struct inode *inode,
2116                              loff_t lstart, loff_t lend);
2117 extern int ext4_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf);
2118 extern qsize_t *ext4_get_reserved_space(struct inode *inode);
2119 extern void ext4_da_update_reserve_space(struct inode *inode,
2120                                         int used, int quota_claim);
2121
2122 /* indirect.c */
2123 extern int ext4_ind_map_blocks(handle_t *handle, struct inode *inode,
2124                                 struct ext4_map_blocks *map, int flags);
2125 extern ssize_t ext4_ind_direct_IO(int rw, struct kiocb *iocb,
2126                                 const struct iovec *iov, loff_t offset,
2127                                 unsigned long nr_segs);
2128 extern int ext4_ind_calc_metadata_amount(struct inode *inode, sector_t lblock);
2129 extern int ext4_ind_trans_blocks(struct inode *inode, int nrblocks);
2130 extern void ext4_ind_truncate(handle_t *, struct inode *inode);
2131 extern int ext4_free_hole_blocks(handle_t *handle, struct inode *inode,
2132                                  ext4_lblk_t first, ext4_lblk_t stop);
2133
2134 /* ioctl.c */
2135 extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
2136 extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
2137
2138 /* migrate.c */
2139 extern int ext4_ext_migrate(struct inode *);
2140 extern int ext4_ind_migrate(struct inode *inode);
2141
2142 /* namei.c */
2143 extern int ext4_dirent_csum_verify(struct inode *inode,
2144                                    struct ext4_dir_entry *dirent);
2145 extern int ext4_orphan_add(handle_t *, struct inode *);
2146 extern int ext4_orphan_del(handle_t *, struct inode *);
2147 extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
2148                                 __u32 start_minor_hash, __u32 *next_hash);
2149 extern int search_dir(struct buffer_head *bh,
2150                       char *search_buf,
2151                       int buf_size,
2152                       struct inode *dir,
2153                       const struct qstr *d_name,
2154                       unsigned int offset,
2155                       struct ext4_dir_entry_2 **res_dir);
2156 extern int ext4_generic_delete_entry(handle_t *handle,
2157                                      struct inode *dir,
2158                                      struct ext4_dir_entry_2 *de_del,
2159                                      struct buffer_head *bh,
2160                                      void *entry_buf,
2161                                      int buf_size,
2162                                      int csum_size);
2163
2164 /* resize.c */
2165 extern int ext4_group_add(struct super_block *sb,
2166                                 struct ext4_new_group_data *input);
2167 extern int ext4_group_extend(struct super_block *sb,
2168                                 struct ext4_super_block *es,
2169                                 ext4_fsblk_t n_blocks_count);
2170 extern int ext4_resize_fs(struct super_block *sb, ext4_fsblk_t n_blocks_count);
2171
2172 /* super.c */
2173 extern int ext4_calculate_overhead(struct super_block *sb);
2174 extern int ext4_superblock_csum_verify(struct super_block *sb,
2175                                        struct ext4_super_block *es);
2176 extern void ext4_superblock_csum_set(struct super_block *sb);
2177 extern void *ext4_kvmalloc(size_t size, gfp_t flags);
2178 extern void *ext4_kvzalloc(size_t size, gfp_t flags);
2179 extern void ext4_kvfree(void *ptr);
2180 extern int ext4_alloc_flex_bg_array(struct super_block *sb,
2181                                     ext4_group_t ngroup);
2182 extern const char *ext4_decode_error(struct super_block *sb, int errno,
2183                                      char nbuf[16]);
2184
2185 extern __printf(4, 5)
2186 void __ext4_error(struct super_block *, const char *, unsigned int,
2187                   const char *, ...);
2188 extern __printf(5, 6)
2189 void __ext4_error_inode(struct inode *, const char *, unsigned int, ext4_fsblk_t,
2190                       const char *, ...);
2191 extern __printf(5, 6)
2192 void __ext4_error_file(struct file *, const char *, unsigned int, ext4_fsblk_t,
2193                      const char *, ...);
2194 extern void __ext4_std_error(struct super_block *, const char *,
2195                              unsigned int, int);
2196 extern __printf(4, 5)
2197 void __ext4_abort(struct super_block *, const char *, unsigned int,
2198                   const char *, ...);
2199 extern __printf(4, 5)
2200 void __ext4_warning(struct super_block *, const char *, unsigned int,
2201                     const char *, ...);
2202 extern __printf(3, 4)
2203 void __ext4_msg(struct super_block *, const char *, const char *, ...);
2204 extern void __dump_mmp_msg(struct super_block *, struct mmp_struct *mmp,
2205                            const char *, unsigned int, const char *);
2206 extern __printf(7, 8)
2207 void __ext4_grp_locked_error(const char *, unsigned int,
2208                              struct super_block *, ext4_group_t,
2209                              unsigned long, ext4_fsblk_t,
2210                              const char *, ...);
2211
2212 #ifdef CONFIG_PRINTK
2213
2214 #define ext4_error_inode(inode, func, line, block, fmt, ...)            \
2215         __ext4_error_inode(inode, func, line, block, fmt, ##__VA_ARGS__)
2216 #define ext4_error_file(file, func, line, block, fmt, ...)              \
2217         __ext4_error_file(file, func, line, block, fmt, ##__VA_ARGS__)
2218 #define ext4_error(sb, fmt, ...)                                        \
2219         __ext4_error(sb, __func__, __LINE__, fmt, ##__VA_ARGS__)
2220 #define ext4_abort(sb, fmt, ...)                                        \
2221         __ext4_abort(sb, __func__, __LINE__, fmt, ##__VA_ARGS__)
2222 #define ext4_warning(sb, fmt, ...)                                      \
2223         __ext4_warning(sb, __func__, __LINE__, fmt, ##__VA_ARGS__)
2224 #define ext4_msg(sb, level, fmt, ...)                           \
2225         __ext4_msg(sb, level, fmt, ##__VA_ARGS__)
2226 #define dump_mmp_msg(sb, mmp, msg)                                      \
2227         __dump_mmp_msg(sb, mmp, __func__, __LINE__, msg)
2228 #define ext4_grp_locked_error(sb, grp, ino, block, fmt, ...)            \
2229         __ext4_grp_locked_error(__func__, __LINE__, sb, grp, ino, block, \
2230                                 fmt, ##__VA_ARGS__)
2231
2232 #else
2233
2234 #define ext4_error_inode(inode, func, line, block, fmt, ...)            \
2235 do {                                                                    \
2236         no_printk(fmt, ##__VA_ARGS__);                                  \
2237         __ext4_error_inode(inode, "", 0, block, " ");                   \
2238 } while (0)
2239 #define ext4_error_file(file, func, line, block, fmt, ...)              \
2240 do {                                                                    \
2241         no_printk(fmt, ##__VA_ARGS__);                                  \
2242         __ext4_error_file(file, "", 0, block, " ");                     \
2243 } while (0)
2244 #define ext4_error(sb, fmt, ...)                                        \
2245 do {                                                                    \
2246         no_printk(fmt, ##__VA_ARGS__);                                  \
2247         __ext4_error(sb, "", 0, " ");                                   \
2248 } while (0)
2249 #define ext4_abort(sb, fmt, ...)                                        \
2250 do {                                                                    \
2251         no_printk(fmt, ##__VA_ARGS__);                                  \
2252         __ext4_abort(sb, "", 0, " ");                                   \
2253 } while (0)
2254 #define ext4_warning(sb, fmt, ...)                                      \
2255 do {                                                                    \
2256         no_printk(fmt, ##__VA_ARGS__);                                  \
2257         __ext4_warning(sb, "", 0, " ");                                 \
2258 } while (0)
2259 #define ext4_msg(sb, level, fmt, ...)                                   \
2260 do {                                                                    \
2261         no_printk(fmt, ##__VA_ARGS__);                                  \
2262         __ext4_msg(sb, "", " ");                                        \
2263 } while (0)
2264 #define dump_mmp_msg(sb, mmp, msg)                                      \
2265         __dump_mmp_msg(sb, mmp, "", 0, "")
2266 #define ext4_grp_locked_error(sb, grp, ino, block, fmt, ...)            \
2267 do {                                                                    \
2268         no_printk(fmt, ##__VA_ARGS__);                          \
2269         __ext4_grp_locked_error("", 0, sb, grp, ino, block, " ");       \
2270 } while (0)
2271
2272 #endif
2273
2274 extern void ext4_update_dynamic_rev(struct super_block *sb);
2275 extern int ext4_update_compat_feature(handle_t *handle, struct super_block *sb,
2276                                         __u32 compat);
2277 extern int ext4_update_rocompat_feature(handle_t *handle,
2278                                         struct super_block *sb, __u32 rocompat);
2279 extern int ext4_update_incompat_feature(handle_t *handle,
2280                                         struct super_block *sb, __u32 incompat);
2281 extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
2282                                       struct ext4_group_desc *bg);
2283 extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
2284                                       struct ext4_group_desc *bg);
2285 extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
2286                                      struct ext4_group_desc *bg);
2287 extern __u32 ext4_free_group_clusters(struct super_block *sb,
2288                                       struct ext4_group_desc *bg);
2289 extern __u32 ext4_free_inodes_count(struct super_block *sb,
2290                                  struct ext4_group_desc *bg);
2291 extern __u32 ext4_used_dirs_count(struct super_block *sb,
2292                                 struct ext4_group_desc *bg);
2293 extern __u32 ext4_itable_unused_count(struct super_block *sb,
2294                                    struct ext4_group_desc *bg);
2295 extern void ext4_block_bitmap_set(struct super_block *sb,
2296                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
2297 extern void ext4_inode_bitmap_set(struct super_block *sb,
2298                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
2299 extern void ext4_inode_table_set(struct super_block *sb,
2300                                  struct ext4_group_desc *bg, ext4_fsblk_t blk);
2301 extern void ext4_free_group_clusters_set(struct super_block *sb,
2302                                          struct ext4_group_desc *bg,
2303                                          __u32 count);
2304 extern void ext4_free_inodes_set(struct super_block *sb,
2305                                 struct ext4_group_desc *bg, __u32 count);
2306 extern void ext4_used_dirs_set(struct super_block *sb,
2307                                 struct ext4_group_desc *bg, __u32 count);
2308 extern void ext4_itable_unused_set(struct super_block *sb,
2309                                    struct ext4_group_desc *bg, __u32 count);
2310 extern int ext4_group_desc_csum_verify(struct super_block *sb, __u32 group,
2311                                        struct ext4_group_desc *gdp);
2312 extern void ext4_group_desc_csum_set(struct super_block *sb, __u32 group,
2313                                      struct ext4_group_desc *gdp);
2314 extern int ext4_register_li_request(struct super_block *sb,
2315                                     ext4_group_t first_not_zeroed);
2316
2317 static inline int ext4_has_group_desc_csum(struct super_block *sb)
2318 {
2319         return EXT4_HAS_RO_COMPAT_FEATURE(sb,
2320                                           EXT4_FEATURE_RO_COMPAT_GDT_CSUM |
2321                                           EXT4_FEATURE_RO_COMPAT_METADATA_CSUM);
2322 }
2323
2324 static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
2325 {
2326         return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
2327                 le32_to_cpu(es->s_blocks_count_lo);
2328 }
2329
2330 static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
2331 {
2332         return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
2333                 le32_to_cpu(es->s_r_blocks_count_lo);
2334 }
2335
2336 static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
2337 {
2338         return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
2339                 le32_to_cpu(es->s_free_blocks_count_lo);
2340 }
2341
2342 static inline void ext4_blocks_count_set(struct ext4_super_block *es,
2343                                          ext4_fsblk_t blk)
2344 {
2345         es->s_blocks_count_lo = cpu_to_le32((u32)blk);
2346         es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
2347 }
2348
2349 static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
2350                                               ext4_fsblk_t blk)
2351 {
2352         es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
2353         es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
2354 }
2355
2356 static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
2357                                            ext4_fsblk_t blk)
2358 {
2359         es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
2360         es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
2361 }
2362
2363 static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
2364 {
2365         if (S_ISREG(le16_to_cpu(raw_inode->i_mode)))
2366                 return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
2367                         le32_to_cpu(raw_inode->i_size_lo);
2368         else
2369                 return (loff_t) le32_to_cpu(raw_inode->i_size_lo);
2370 }
2371
2372 static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
2373 {
2374         raw_inode->i_size_lo = cpu_to_le32(i_size);
2375         raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
2376 }
2377
2378 static inline
2379 struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
2380                                             ext4_group_t group)
2381 {
2382          struct ext4_group_info ***grp_info;
2383          long indexv, indexh;
2384          BUG_ON(group >= EXT4_SB(sb)->s_groups_count);
2385          grp_info = EXT4_SB(sb)->s_group_info;
2386          indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
2387          indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
2388          return grp_info[indexv][indexh];
2389 }
2390
2391 /*
2392  * Reading s_groups_count requires using smp_rmb() afterwards.  See
2393  * the locking protocol documented in the comments of ext4_group_add()
2394  * in resize.c
2395  */
2396 static inline ext4_group_t ext4_get_groups_count(struct super_block *sb)
2397 {
2398         ext4_group_t    ngroups = EXT4_SB(sb)->s_groups_count;
2399
2400         smp_rmb();
2401         return ngroups;
2402 }
2403
2404 static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
2405                                              ext4_group_t block_group)
2406 {
2407         return block_group >> sbi->s_log_groups_per_flex;
2408 }
2409
2410 static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
2411 {
2412         return 1 << sbi->s_log_groups_per_flex;
2413 }
2414
2415 #define ext4_std_error(sb, errno)                               \
2416 do {                                                            \
2417         if ((errno))                                            \
2418                 __ext4_std_error((sb), __func__, __LINE__, (errno));    \
2419 } while (0)
2420
2421 #ifdef CONFIG_SMP
2422 /* Each CPU can accumulate percpu_counter_batch clusters in their local
2423  * counters. So we need to make sure we have free clusters more
2424  * than percpu_counter_batch  * nr_cpu_ids. Also add a window of 4 times.
2425  */
2426 #define EXT4_FREECLUSTERS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
2427 #else
2428 #define EXT4_FREECLUSTERS_WATERMARK 0
2429 #endif
2430
2431 static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
2432 {
2433         /*
2434          * XXX: replace with spinlock if seen contended -bzzz
2435          */
2436         down_write(&EXT4_I(inode)->i_data_sem);
2437         if (newsize > EXT4_I(inode)->i_disksize)
2438                 EXT4_I(inode)->i_disksize = newsize;
2439         up_write(&EXT4_I(inode)->i_data_sem);
2440         return ;
2441 }
2442
2443 struct ext4_group_info {
2444         unsigned long   bb_state;
2445         struct rb_root  bb_free_root;
2446         ext4_grpblk_t   bb_first_free;  /* first free block */
2447         ext4_grpblk_t   bb_free;        /* total free blocks */
2448         ext4_grpblk_t   bb_fragments;   /* nr of freespace fragments */
2449         ext4_grpblk_t   bb_largest_free_order;/* order of largest frag in BG */
2450         struct          list_head bb_prealloc_list;
2451 #ifdef DOUBLE_CHECK
2452         void            *bb_bitmap;
2453 #endif
2454         struct rw_semaphore alloc_sem;
2455         ext4_grpblk_t   bb_counters[];  /* Nr of free power-of-two-block
2456                                          * regions, index is order.
2457                                          * bb_counters[3] = 5 means
2458                                          * 5 free 8-block regions. */
2459 };
2460
2461 #define EXT4_GROUP_INFO_NEED_INIT_BIT           0
2462 #define EXT4_GROUP_INFO_WAS_TRIMMED_BIT         1
2463
2464 #define EXT4_MB_GRP_NEED_INIT(grp)      \
2465         (test_bit(EXT4_GROUP_INFO_NEED_INIT_BIT, &((grp)->bb_state)))
2466
2467 #define EXT4_MB_GRP_WAS_TRIMMED(grp)    \
2468         (test_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
2469 #define EXT4_MB_GRP_SET_TRIMMED(grp)    \
2470         (set_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
2471 #define EXT4_MB_GRP_CLEAR_TRIMMED(grp)  \
2472         (clear_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
2473
2474 #define EXT4_MAX_CONTENTION             8
2475 #define EXT4_CONTENTION_THRESHOLD       2
2476
2477 static inline spinlock_t *ext4_group_lock_ptr(struct super_block *sb,
2478                                               ext4_group_t group)
2479 {
2480         return bgl_lock_ptr(EXT4_SB(sb)->s_blockgroup_lock, group);
2481 }
2482
2483 /*
2484  * Returns true if the filesystem is busy enough that attempts to
2485  * access the block group locks has run into contention.
2486  */
2487 static inline int ext4_fs_is_busy(struct ext4_sb_info *sbi)
2488 {
2489         return (atomic_read(&sbi->s_lock_busy) > EXT4_CONTENTION_THRESHOLD);
2490 }
2491
2492 static inline void ext4_lock_group(struct super_block *sb, ext4_group_t group)
2493 {
2494         spinlock_t *lock = ext4_group_lock_ptr(sb, group);
2495         if (spin_trylock(lock))
2496                 /*
2497                  * We're able to grab the lock right away, so drop the
2498                  * lock contention counter.
2499                  */
2500                 atomic_add_unless(&EXT4_SB(sb)->s_lock_busy, -1, 0);
2501         else {
2502                 /*
2503                  * The lock is busy, so bump the contention counter,
2504                  * and then wait on the spin lock.
2505                  */
2506                 atomic_add_unless(&EXT4_SB(sb)->s_lock_busy, 1,
2507                                   EXT4_MAX_CONTENTION);
2508                 spin_lock(lock);
2509         }
2510 }
2511
2512 static inline void ext4_unlock_group(struct super_block *sb,
2513                                         ext4_group_t group)
2514 {
2515         spin_unlock(ext4_group_lock_ptr(sb, group));
2516 }
2517
2518 /*
2519  * Block validity checking
2520  */
2521 #define ext4_check_indirect_blockref(inode, bh)                         \
2522         ext4_check_blockref(__func__, __LINE__, inode,                  \
2523                             (__le32 *)(bh)->b_data,                     \
2524                             EXT4_ADDR_PER_BLOCK((inode)->i_sb))
2525
2526 #define ext4_ind_check_inode(inode)                                     \
2527         ext4_check_blockref(__func__, __LINE__, inode,                  \
2528                             EXT4_I(inode)->i_data,                      \
2529                             EXT4_NDIR_BLOCKS)
2530
2531 /*
2532  * Inodes and files operations
2533  */
2534
2535 /* dir.c */
2536 extern const struct file_operations ext4_dir_operations;
2537
2538 /* file.c */
2539 extern const struct inode_operations ext4_file_inode_operations;
2540 extern const struct file_operations ext4_file_operations;
2541 extern loff_t ext4_llseek(struct file *file, loff_t offset, int origin);
2542 extern void ext4_unwritten_wait(struct inode *inode);
2543
2544 /* inline.c */
2545 extern int ext4_has_inline_data(struct inode *inode);
2546 extern int ext4_get_inline_size(struct inode *inode);
2547 extern int ext4_get_max_inline_size(struct inode *inode);
2548 extern int ext4_find_inline_data_nolock(struct inode *inode);
2549 extern void ext4_write_inline_data(struct inode *inode,
2550                                    struct ext4_iloc *iloc,
2551                                    void *buffer, loff_t pos,
2552                                    unsigned int len);
2553 extern int ext4_prepare_inline_data(handle_t *handle, struct inode *inode,
2554                                     unsigned int len);
2555 extern int ext4_init_inline_data(handle_t *handle, struct inode *inode,
2556                                  unsigned int len);
2557 extern int ext4_destroy_inline_data(handle_t *handle, struct inode *inode);
2558
2559 extern int ext4_readpage_inline(struct inode *inode, struct page *page);
2560 extern int ext4_try_to_write_inline_data(struct address_space *mapping,
2561                                          struct inode *inode,
2562                                          loff_t pos, unsigned len,
2563                                          unsigned flags,
2564                                          struct page **pagep);
2565 extern int ext4_write_inline_data_end(struct inode *inode,
2566                                       loff_t pos, unsigned len,
2567                                       unsigned copied,
2568                                       struct page *page);
2569 extern struct buffer_head *
2570 ext4_journalled_write_inline_data(struct inode *inode,
2571                                   unsigned len,
2572                                   struct page *page);
2573 extern int ext4_da_write_inline_data_begin(struct address_space *mapping,
2574                                            struct inode *inode,
2575                                            loff_t pos, unsigned len,
2576                                            unsigned flags,
2577                                            struct page **pagep,
2578                                            void **fsdata);
2579 extern int ext4_da_write_inline_data_end(struct inode *inode, loff_t pos,
2580                                          unsigned len, unsigned copied,
2581                                          struct page *page);
2582 extern int ext4_try_add_inline_entry(handle_t *handle, struct dentry *dentry,
2583                                      struct inode *inode);
2584 extern int ext4_try_create_inline_dir(handle_t *handle,
2585                                       struct inode *parent,
2586                                       struct inode *inode);
2587 extern int ext4_read_inline_dir(struct file *filp,
2588                                 struct dir_context *ctx,
2589                                 int *has_inline_data);
2590 extern int htree_inlinedir_to_tree(struct file *dir_file,
2591                                    struct inode *dir, ext4_lblk_t block,
2592                                    struct dx_hash_info *hinfo,
2593                                    __u32 start_hash, __u32 start_minor_hash,
2594                                    int *has_inline_data);
2595 extern struct buffer_head *ext4_find_inline_entry(struct inode *dir,
2596                                         const struct qstr *d_name,
2597                                         struct ext4_dir_entry_2 **res_dir,
2598                                         int *has_inline_data);
2599 extern int ext4_delete_inline_entry(handle_t *handle,
2600                                     struct inode *dir,
2601                                     struct ext4_dir_entry_2 *de_del,
2602                                     struct buffer_head *bh,
2603                                     int *has_inline_data);
2604 extern int empty_inline_dir(struct inode *dir, int *has_inline_data);
2605 extern struct buffer_head *ext4_get_first_inline_block(struct inode *inode,
2606                                         struct ext4_dir_entry_2 **parent_de,
2607                                         int *retval);
2608 extern int ext4_inline_data_fiemap(struct inode *inode,
2609                                    struct fiemap_extent_info *fieinfo,
2610                                    int *has_inline);
2611 extern int ext4_try_to_evict_inline_data(handle_t *handle,
2612                                          struct inode *inode,
2613                                          int needed);
2614 extern void ext4_inline_data_truncate(struct inode *inode, int *has_inline);
2615
2616 extern int ext4_convert_inline_data(struct inode *inode);
2617
2618 /* namei.c */
2619 extern const struct inode_operations ext4_dir_inode_operations;
2620 extern const struct inode_operations ext4_special_inode_operations;
2621 extern struct dentry *ext4_get_parent(struct dentry *child);
2622 extern struct ext4_dir_entry_2 *ext4_init_dot_dotdot(struct inode *inode,
2623                                  struct ext4_dir_entry_2 *de,
2624                                  int blocksize, int csum_size,
2625                                  unsigned int parent_ino, int dotdot_real_len);
2626 extern void initialize_dirent_tail(struct ext4_dir_entry_tail *t,
2627                                    unsigned int blocksize);
2628 extern int ext4_handle_dirty_dirent_node(handle_t *handle,
2629                                          struct inode *inode,
2630                                          struct buffer_head *bh);
2631 #define S_SHIFT 12
2632 static unsigned char ext4_type_by_mode[S_IFMT >> S_SHIFT] = {
2633         [S_IFREG >> S_SHIFT]    = EXT4_FT_REG_FILE,
2634         [S_IFDIR >> S_SHIFT]    = EXT4_FT_DIR,
2635         [S_IFCHR >> S_SHIFT]    = EXT4_FT_CHRDEV,
2636         [S_IFBLK >> S_SHIFT]    = EXT4_FT_BLKDEV,
2637         [S_IFIFO >> S_SHIFT]    = EXT4_FT_FIFO,
2638         [S_IFSOCK >> S_SHIFT]   = EXT4_FT_SOCK,
2639         [S_IFLNK >> S_SHIFT]    = EXT4_FT_SYMLINK,
2640 };
2641
2642 static inline void ext4_set_de_type(struct super_block *sb,
2643                                 struct ext4_dir_entry_2 *de,
2644                                 umode_t mode) {
2645         if (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_FILETYPE))
2646                 de->file_type = ext4_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
2647 }
2648
2649
2650 /* symlink.c */
2651 extern const struct inode_operations ext4_symlink_inode_operations;
2652 extern const struct inode_operations ext4_fast_symlink_inode_operations;
2653
2654 /* block_validity */
2655 extern void ext4_release_system_zone(struct super_block *sb);
2656 extern int ext4_setup_system_zone(struct super_block *sb);
2657 extern int __init ext4_init_system_zone(void);
2658 extern void ext4_exit_system_zone(void);
2659 extern int ext4_data_block_valid(struct ext4_sb_info *sbi,
2660                                  ext4_fsblk_t start_blk,
2661                                  unsigned int count);
2662 extern int ext4_check_blockref(const char *, unsigned int,
2663                                struct inode *, __le32 *, unsigned int);
2664
2665 /* extents.c */
2666 struct ext4_ext_path;
2667 struct ext4_extent;
2668
2669 extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
2670 extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
2671 extern int ext4_ext_index_trans_blocks(struct inode *inode, int extents);
2672 extern int ext4_ext_map_blocks(handle_t *handle, struct inode *inode,
2673                                struct ext4_map_blocks *map, int flags);
2674 extern void ext4_ext_truncate(handle_t *, struct inode *);
2675 extern int ext4_ext_remove_space(struct inode *inode, ext4_lblk_t start,
2676                                  ext4_lblk_t end);
2677 extern void ext4_ext_init(struct super_block *);
2678 extern void ext4_ext_release(struct super_block *);
2679 extern long ext4_fallocate(struct file *file, int mode, loff_t offset,
2680                           loff_t len);
2681 extern int ext4_convert_unwritten_extents(handle_t *handle, struct inode *inode,
2682                                           loff_t offset, ssize_t len);
2683 extern int ext4_map_blocks(handle_t *handle, struct inode *inode,
2684                            struct ext4_map_blocks *map, int flags);
2685 extern int ext4_ext_calc_metadata_amount(struct inode *inode,
2686                                          ext4_lblk_t lblocks);
2687 extern int ext4_extent_tree_init(handle_t *, struct inode *);
2688 extern int ext4_ext_calc_credits_for_single_extent(struct inode *inode,
2689                                                    int num,
2690                                                    struct ext4_ext_path *path);
2691 extern int ext4_can_extents_be_merged(struct inode *inode,
2692                                       struct ext4_extent *ex1,
2693                                       struct ext4_extent *ex2);
2694 extern int ext4_ext_insert_extent(handle_t *, struct inode *,
2695                                   struct ext4_ext_path *,
2696                                   struct ext4_extent *, int);
2697 extern struct ext4_ext_path *ext4_ext_find_extent(struct inode *, ext4_lblk_t,
2698                                                   struct ext4_ext_path *,
2699                                                   int flags);
2700 extern void ext4_ext_drop_refs(struct ext4_ext_path *);
2701 extern int ext4_ext_check_inode(struct inode *inode);
2702 extern int ext4_find_delalloc_range(struct inode *inode,
2703                                     ext4_lblk_t lblk_start,
2704                                     ext4_lblk_t lblk_end);
2705 extern int ext4_find_delalloc_cluster(struct inode *inode, ext4_lblk_t lblk);
2706 extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
2707                         __u64 start, __u64 len);
2708
2709
2710 /* move_extent.c */
2711 extern void ext4_double_down_write_data_sem(struct inode *first,
2712                                             struct inode *second);
2713 extern void ext4_double_up_write_data_sem(struct inode *orig_inode,
2714                                           struct inode *donor_inode);
2715 void ext4_inode_double_lock(struct inode *inode1, struct inode *inode2);
2716 void ext4_inode_double_unlock(struct inode *inode1, struct inode *inode2);
2717 extern int ext4_move_extents(struct file *o_filp, struct file *d_filp,
2718                              __u64 start_orig, __u64 start_donor,
2719                              __u64 len, __u64 *moved_len);
2720
2721 /* page-io.c */
2722 extern int __init ext4_init_pageio(void);
2723 extern void ext4_exit_pageio(void);
2724 extern ext4_io_end_t *ext4_init_io_end(struct inode *inode, gfp_t flags);
2725 extern ext4_io_end_t *ext4_get_io_end(ext4_io_end_t *io_end);
2726 extern int ext4_put_io_end(ext4_io_end_t *io_end);
2727 extern void ext4_put_io_end_defer(ext4_io_end_t *io_end);
2728 extern void ext4_io_submit_init(struct ext4_io_submit *io,
2729                                 struct writeback_control *wbc);
2730 extern void ext4_end_io_rsv_work(struct work_struct *work);
2731 extern void ext4_end_io_unrsv_work(struct work_struct *work);
2732 extern void ext4_io_submit(struct ext4_io_submit *io);
2733 extern int ext4_bio_write_page(struct ext4_io_submit *io,
2734                                struct page *page,
2735                                int len,
2736                                struct writeback_control *wbc);
2737
2738 /* mmp.c */
2739 extern int ext4_multi_mount_protect(struct super_block *, ext4_fsblk_t);
2740 extern void ext4_mmp_csum_set(struct super_block *sb, struct mmp_struct *mmp);
2741 extern int ext4_mmp_csum_verify(struct super_block *sb,
2742                                 struct mmp_struct *mmp);
2743
2744 /*
2745  * Note that these flags will never ever appear in a buffer_head's state flag.
2746  * See EXT4_MAP_... to see where this is used.
2747  */
2748 enum ext4_state_bits {
2749         BH_Uninit       /* blocks are allocated but uninitialized on disk */
2750          = BH_JBDPrivateStart,
2751         BH_AllocFromCluster,    /* allocated blocks were part of already
2752                                  * allocated cluster. */
2753 };
2754
2755 /*
2756  * Add new method to test whether block and inode bitmaps are properly
2757  * initialized. With uninit_bg reading the block from disk is not enough
2758  * to mark the bitmap uptodate. We need to also zero-out the bitmap
2759  */
2760 #define BH_BITMAP_UPTODATE BH_JBDPrivateStart
2761
2762 static inline int bitmap_uptodate(struct buffer_head *bh)
2763 {
2764         return (buffer_uptodate(bh) &&
2765                         test_bit(BH_BITMAP_UPTODATE, &(bh)->b_state));
2766 }
2767 static inline void set_bitmap_uptodate(struct buffer_head *bh)
2768 {
2769         set_bit(BH_BITMAP_UPTODATE, &(bh)->b_state);
2770 }
2771
2772 /*
2773  * Disable DIO read nolock optimization, so new dioreaders will be forced
2774  * to grab i_mutex
2775  */
2776 static inline void ext4_inode_block_unlocked_dio(struct inode *inode)
2777 {
2778         ext4_set_inode_state(inode, EXT4_STATE_DIOREAD_LOCK);
2779         smp_mb();
2780 }
2781 static inline void ext4_inode_resume_unlocked_dio(struct inode *inode)
2782 {
2783         smp_mb();
2784         ext4_clear_inode_state(inode, EXT4_STATE_DIOREAD_LOCK);
2785 }
2786
2787 #define in_range(b, first, len) ((b) >= (first) && (b) <= (first) + (len) - 1)
2788
2789 /* For ioend & aio unwritten conversion wait queues */
2790 #define EXT4_WQ_HASH_SZ         37
2791 #define ext4_ioend_wq(v)   (&ext4__ioend_wq[((unsigned long)(v)) %\
2792                                             EXT4_WQ_HASH_SZ])
2793 #define ext4_aio_mutex(v)  (&ext4__aio_mutex[((unsigned long)(v)) %\
2794                                              EXT4_WQ_HASH_SZ])
2795 extern wait_queue_head_t ext4__ioend_wq[EXT4_WQ_HASH_SZ];
2796 extern struct mutex ext4__aio_mutex[EXT4_WQ_HASH_SZ];
2797
2798 #define EXT4_RESIZING   0
2799 extern int ext4_resize_begin(struct super_block *sb);
2800 extern void ext4_resize_end(struct super_block *sb);
2801
2802 #endif  /* __KERNEL__ */
2803
2804 #endif  /* _EXT4_H */