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