fs/ext4/ext4.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  ext4.h
   4  *
   5  * Copyright (C) 1992, 1993, 1994, 1995
   6  * Remy Card (card@masi.ibp.fr)
   7  * Laboratoire MASI - Institut Blaise Pascal
   8  * Universite Pierre et Marie Curie (Paris VI)
   9  *
  10  *  from
  11  *
  12  *  linux/include/linux/minix_fs.h
  13  *
  14  *  Copyright (C) 1991, 1992  Linus Torvalds
  15  */
  16
  17 #ifndef _EXT4_H
  18 #define _EXT4_H
  19
  20 #include <linux/types.h>
  21 #include <linux/blkdev.h>
  22 #include <linux/magic.h>
  23 #include <linux/jbd2.h>
  24 #include <linux/quota.h>
  25 #include <linux/rwsem.h>
  26 #include <linux/rbtree.h>
  27 #include <linux/seqlock.h>
  28 #include <linux/mutex.h>
  29 #include <linux/timer.h>
  30 #include <linux/wait.h>
  31 #include <linux/sched/signal.h>
  32 #include <linux/blockgroup_lock.h>
  33 #include <linux/percpu_counter.h>
  34 #include <linux/ratelimit.h>
  35 #include <crypto/hash.h>
  36 #include <linux/falloc.h>
  37 #include <linux/percpu-rwsem.h>
  38 #include <linux/fiemap.h>
  39 #ifdef __KERNEL__
  40 #include <linux/compat.h>
  41 #endif
  42
  43 #include <linux/fscrypt.h>
  44 #include <linux/fsverity.h>
  45
  46 #include <linux/compiler.h>
  47
  48 /*
  49  * The fourth extended filesystem constants/structures
  50  */
  51
  52 /*
  53  * with AGGRESSIVE_CHECK allocator runs consistency checks over
  54  * structures. these checks slow things down a lot
  55  */
  56 #define AGGRESSIVE_CHECK__
  57
  58 /*
  59  * with DOUBLE_CHECK defined mballoc creates persistent in-core
  60  * bitmaps, maintains and uses them to check for double allocations
  61  */
  62 #define DOUBLE_CHECK__
  63
  64 /*
  65  * Define EXT4FS_DEBUG to produce debug messages
  66  */
  67 #undef EXT4FS_DEBUG
  68
  69 /*
  70  * Debug code
  71  */
  72 #ifdef EXT4FS_DEBUG
  73 #define ext4_debug(f, a...)                                             \
  74         do {                                                            \
  75                 printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:",        \
  76                         __FILE__, __LINE__, __func__);                  \
  77                 printk(KERN_DEBUG f, ## a);                             \
  78         } while (0)
  79 #else
  80 #define ext4_debug(fmt, ...)    no_printk(fmt, ##__VA_ARGS__)
  81 #endif
  82
  83  /*
  84   * Turn on EXT_DEBUG to enable ext4_ext_show_path/leaf/move in extents.c
  85   */
  86 #define EXT_DEBUG__
  87
  88 /*
  89  * Dynamic printk for controlled extents debugging.
  90  */
  91 #ifdef CONFIG_EXT4_DEBUG
  92 #define ext_debug(ino, fmt, ...)                                        \
  93         pr_debug("[%s/%d] EXT4-fs (%s): ino %lu: (%s, %d): %s:" fmt,    \
  94                  current->comm, task_pid_nr(current),                   \
  95                  ino->i_sb->s_id, ino->i_ino, __FILE__, __LINE__,       \
  96                  __func__, ##__VA_ARGS__)
  97 #else
  98 #define ext_debug(ino, fmt, ...)        no_printk(fmt, ##__VA_ARGS__)
  99 #endif
 100
 101 #define ASSERT(assert)                                          \
 102 do {                                                                    \
 103         if (unlikely(!(assert))) {                                      \
 104                 printk(KERN_EMERG                                       \
 105                        "Assertion failure in %s() at %s:%d: '%s'\n",    \
 106                        __func__, __FILE__, __LINE__, #assert);          \
 107                 BUG();                                                  \
 108         }                                                               \
 109 } while (0)
 110
 111 /* data type for block offset of block group */
 112 typedef int ext4_grpblk_t;
 113
 114 /* data type for filesystem-wide blocks number */
 115 typedef unsigned long long ext4_fsblk_t;
 116
 117 /* data type for file logical block number */
 118 typedef __u32 ext4_lblk_t;
 119
 120 /* data type for block group number */
 121 typedef unsigned int ext4_group_t;
 122
 123 enum SHIFT_DIRECTION {
 124         SHIFT_LEFT = 0,
 125         SHIFT_RIGHT,
 126 };
 127
 128 /*
 129  * Flags used in mballoc's allocation_context flags field.
 130  *
 131  * Also used to show what's going on for debugging purposes when the
 132  * flag field is exported via the traceport interface
 133  */
 134
 135 /* prefer goal again. length */
 136 #define EXT4_MB_HINT_MERGE              0x0001
 137 /* blocks already reserved */
 138 #define EXT4_MB_HINT_RESERVED           0x0002
 139 /* metadata is being allocated */
 140 #define EXT4_MB_HINT_METADATA           0x0004
 141 /* first blocks in the file */
 142 #define EXT4_MB_HINT_FIRST              0x0008
 143 /* search for the best chunk */
 144 #define EXT4_MB_HINT_BEST               0x0010
 145 /* data is being allocated */
 146 #define EXT4_MB_HINT_DATA               0x0020
 147 /* don't preallocate (for tails) */
 148 #define EXT4_MB_HINT_NOPREALLOC         0x0040
 149 /* allocate for locality group */
 150 #define EXT4_MB_HINT_GROUP_ALLOC        0x0080
 151 /* allocate goal blocks or none */
 152 #define EXT4_MB_HINT_GOAL_ONLY          0x0100
 153 /* goal is meaningful */
 154 #define EXT4_MB_HINT_TRY_GOAL           0x0200
 155 /* blocks already pre-reserved by delayed allocation */
 156 #define EXT4_MB_DELALLOC_RESERVED       0x0400
 157 /* We are doing stream allocation */
 158 #define EXT4_MB_STREAM_ALLOC            0x0800
 159 /* Use reserved root blocks if needed */
 160 #define EXT4_MB_USE_ROOT_BLOCKS         0x1000
 161 /* Use blocks from reserved pool */
 162 #define EXT4_MB_USE_RESERVED            0x2000
 163 /* Do strict check for free blocks while retrying block allocation */
 164 #define EXT4_MB_STRICT_CHECK            0x4000
 165 /* Large fragment size list lookup succeeded at least once for cr = 0 */
 166 #define EXT4_MB_CR0_OPTIMIZED           0x8000
 167 /* Avg fragment size rb tree lookup succeeded at least once for cr = 1 */
 168 #define EXT4_MB_CR1_OPTIMIZED           0x00010000
 169 /* Perform linear traversal for one group */
 170 #define EXT4_MB_SEARCH_NEXT_LINEAR      0x00020000
 171 struct ext4_allocation_request {
 172         /* target inode for block we're allocating */
 173         struct inode *inode;
 174         /* how many blocks we want to allocate */
 175         unsigned int len;
 176         /* logical block in target inode */
 177         ext4_lblk_t logical;
 178         /* the closest logical allocated block to the left */
 179         ext4_lblk_t lleft;
 180         /* the closest logical allocated block to the right */
 181         ext4_lblk_t lright;
 182         /* phys. target (a hint) */
 183         ext4_fsblk_t goal;
 184         /* phys. block for the closest logical allocated block to the left */
 185         ext4_fsblk_t pleft;
 186         /* phys. block for the closest logical allocated block to the right */
 187         ext4_fsblk_t pright;
 188         /* flags. see above EXT4_MB_HINT_* */
 189         unsigned int flags;
 190 };
 191
 192 /*
 193  * Logical to physical block mapping, used by ext4_map_blocks()
 194  *
 195  * This structure is used to pass requests into ext4_map_blocks() as
 196  * well as to store the information returned by ext4_map_blocks().  It
 197  * takes less room on the stack than a struct buffer_head.
 198  */
 199 #define EXT4_MAP_NEW            BIT(BH_New)
 200 #define EXT4_MAP_MAPPED         BIT(BH_Mapped)
 201 #define EXT4_MAP_UNWRITTEN      BIT(BH_Unwritten)
 202 #define EXT4_MAP_BOUNDARY       BIT(BH_Boundary)
 203 #define EXT4_MAP_FLAGS          (EXT4_MAP_NEW | EXT4_MAP_MAPPED |\
 204                                  EXT4_MAP_UNWRITTEN | EXT4_MAP_BOUNDARY)
 205
 206 struct ext4_map_blocks {
 207         ext4_fsblk_t m_pblk;
 208         ext4_lblk_t m_lblk;
 209         unsigned int m_len;
 210         unsigned int m_flags;
 211 };
 212
 213 /*
 214  * Block validity checking, system zone rbtree.
 215  */
 216 struct ext4_system_blocks {
 217         struct rb_root root;
 218         struct rcu_head rcu;
 219 };
 220
 221 /*
 222  * Flags for ext4_io_end->flags
 223  */
 224 #define EXT4_IO_END_UNWRITTEN   0x0001
 225
 226 struct ext4_io_end_vec {
 227         struct list_head list;          /* list of io_end_vec */
 228         loff_t offset;                  /* offset in the file */
 229         ssize_t size;                   /* size of the extent */
 230 };
 231
 232 /*
 233  * For converting unwritten extents on a work queue. 'handle' is used for
 234  * buffered writeback.
 235  */
 236 typedef struct ext4_io_end {
 237         struct list_head        list;           /* per-file finished IO list */
 238         handle_t                *handle;        /* handle reserved for extent
 239                                                  * conversion */
 240         struct inode            *inode;         /* file being written to */
 241         struct bio              *bio;           /* Linked list of completed
 242                                                  * bios covering the extent */
 243         unsigned int            flag;           /* unwritten or not */
 244         atomic_t                count;          /* reference counter */
 245         struct list_head        list_vec;       /* list of ext4_io_end_vec */
 246 } ext4_io_end_t;
 247
 248 struct ext4_io_submit {
 249         struct writeback_control *io_wbc;
 250         struct bio              *io_bio;
 251         ext4_io_end_t           *io_end;
 252         sector_t                io_next_block;
 253 };
 254
 255 /*
 256  * Special inodes numbers
 257  */
 258 #define EXT4_BAD_INO             1      /* Bad blocks inode */
 259 #define EXT4_ROOT_INO            2      /* Root inode */
 260 #define EXT4_USR_QUOTA_INO       3      /* User quota inode */
 261 #define EXT4_GRP_QUOTA_INO       4      /* Group quota inode */
 262 #define EXT4_BOOT_LOADER_INO     5      /* Boot loader inode */
 263 #define EXT4_UNDEL_DIR_INO       6      /* Undelete directory inode */
 264 #define EXT4_RESIZE_INO          7      /* Reserved group descriptors inode */
 265 #define EXT4_JOURNAL_INO         8      /* Journal inode */
 266
 267 /* First non-reserved inode for old ext4 filesystems */
 268 #define EXT4_GOOD_OLD_FIRST_INO 11
 269
 270 /*
 271  * Maximal count of links to a file
 272  */
 273 #define EXT4_LINK_MAX           65000
 274
 275 /*
 276  * Macro-instructions used to manage several block sizes
 277  */
 278 #define EXT4_MIN_BLOCK_SIZE             1024
 279 #define EXT4_MAX_BLOCK_SIZE             65536
 280 #define EXT4_MIN_BLOCK_LOG_SIZE         10
 281 #define EXT4_MAX_BLOCK_LOG_SIZE         16
 282 #define EXT4_MAX_CLUSTER_LOG_SIZE       30
 283 #ifdef __KERNEL__
 284 # define EXT4_BLOCK_SIZE(s)             ((s)->s_blocksize)
 285 #else
 286 # define EXT4_BLOCK_SIZE(s)             (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
 287 #endif
 288 #define EXT4_ADDR_PER_BLOCK(s)          (EXT4_BLOCK_SIZE(s) / sizeof(__u32))
 289 #define EXT4_CLUSTER_SIZE(s)            (EXT4_BLOCK_SIZE(s) << \
 290                                          EXT4_SB(s)->s_cluster_bits)
 291 #ifdef __KERNEL__
 292 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_blocksize_bits)
 293 # define EXT4_CLUSTER_BITS(s)           (EXT4_SB(s)->s_cluster_bits)
 294 #else
 295 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_log_block_size + 10)
 296 #endif
 297 #ifdef __KERNEL__
 298 #define EXT4_ADDR_PER_BLOCK_BITS(s)     (EXT4_SB(s)->s_addr_per_block_bits)
 299 #define EXT4_INODE_SIZE(s)              (EXT4_SB(s)->s_inode_size)
 300 #define EXT4_FIRST_INO(s)               (EXT4_SB(s)->s_first_ino)
 301 #else
 302 #define EXT4_INODE_SIZE(s)      (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
 303                                  EXT4_GOOD_OLD_INODE_SIZE : \
 304                                  (s)->s_inode_size)
 305 #define EXT4_FIRST_INO(s)       (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
 306                                  EXT4_GOOD_OLD_FIRST_INO : \
 307                                  (s)->s_first_ino)
 308 #endif
 309 #define EXT4_BLOCK_ALIGN(size, blkbits)         ALIGN((size), (1 << (blkbits)))
 310 #define EXT4_MAX_BLOCKS(size, offset, blkbits) \
 311         ((EXT4_BLOCK_ALIGN(size + offset, blkbits) >> blkbits) - (offset >> \
 312                                                                   blkbits))
 313
 314 /* Translate a block number to a cluster number */
 315 #define EXT4_B2C(sbi, blk)      ((blk) >> (sbi)->s_cluster_bits)
 316 /* Translate a cluster number to a block number */
 317 #define EXT4_C2B(sbi, cluster)  ((cluster) << (sbi)->s_cluster_bits)
 318 /* Translate # of blks to # of clusters */
 319 #define EXT4_NUM_B2C(sbi, blks) (((blks) + (sbi)->s_cluster_ratio - 1) >> \
 320                                  (sbi)->s_cluster_bits)
 321 /* Mask out the low bits to get the starting block of the cluster */
 322 #define EXT4_PBLK_CMASK(s, pblk) ((pblk) &                              \
 323                                   ~((ext4_fsblk_t) (s)->s_cluster_ratio - 1))
 324 #define EXT4_LBLK_CMASK(s, lblk) ((lblk) &                              \
 325                                   ~((ext4_lblk_t) (s)->s_cluster_ratio - 1))
 326 /* Fill in the low bits to get the last block of the cluster */
 327 #define EXT4_LBLK_CFILL(sbi, lblk) ((lblk) |                            \
 328                                     ((ext4_lblk_t) (sbi)->s_cluster_ratio - 1))
 329 /* Get the cluster offset */
 330 #define EXT4_PBLK_COFF(s, pblk) ((pblk) &                               \
 331                                  ((ext4_fsblk_t) (s)->s_cluster_ratio - 1))
 332 #define EXT4_LBLK_COFF(s, lblk) ((lblk) &                               \
 333                                  ((ext4_lblk_t) (s)->s_cluster_ratio - 1))
 334
 335 /*
 336  * Structure of a blocks group descriptor
 337  */
 338 struct ext4_group_desc
 339 {
 340         __le32  bg_block_bitmap_lo;     /* Blocks bitmap block */
 341         __le32  bg_inode_bitmap_lo;     /* Inodes bitmap block */
 342         __le32  bg_inode_table_lo;      /* Inodes table block */
 343         __le16  bg_free_blocks_count_lo;/* Free blocks count */
 344         __le16  bg_free_inodes_count_lo;/* Free inodes count */
 345         __le16  bg_used_dirs_count_lo;  /* Directories count */
 346         __le16  bg_flags;               /* EXT4_BG_flags (INODE_UNINIT, etc) */
 347         __le32  bg_exclude_bitmap_lo;   /* Exclude bitmap for snapshots */
 348         __le16  bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bbitmap) LE */
 349         __le16  bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+ibitmap) LE */
 350         __le16  bg_itable_unused_lo;    /* Unused inodes count */
 351         __le16  bg_checksum;            /* crc16(sb_uuid+group+desc) */
 352         __le32  bg_block_bitmap_hi;     /* Blocks bitmap block MSB */
 353         __le32  bg_inode_bitmap_hi;     /* Inodes bitmap block MSB */
 354         __le32  bg_inode_table_hi;      /* Inodes table block MSB */
 355         __le16  bg_free_blocks_count_hi;/* Free blocks count MSB */
 356         __le16  bg_free_inodes_count_hi;/* Free inodes count MSB */
 357         __le16  bg_used_dirs_count_hi;  /* Directories count MSB */
 358         __le16  bg_itable_unused_hi;    /* Unused inodes count MSB */
 359         __le32  bg_exclude_bitmap_hi;   /* Exclude bitmap block MSB */
 360         __le16  bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bbitmap) BE */
 361         __le16  bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+ibitmap) BE */
 362         __u32   bg_reserved;
 363 };
 364
 365 #define EXT4_BG_INODE_BITMAP_CSUM_HI_END        \
 366         (offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
 367          sizeof(__le16))
 368 #define EXT4_BG_BLOCK_BITMAP_CSUM_HI_END        \
 369         (offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
 370          sizeof(__le16))
 371
 372 /*
 373  * Structure of a flex block group info
 374  */
 375
 376 struct flex_groups {
 377         atomic64_t      free_clusters;
 378         atomic_t        free_inodes;
 379         atomic_t        used_dirs;
 380 };
 381
 382 #define EXT4_BG_INODE_UNINIT    0x0001 /* Inode table/bitmap not in use */
 383 #define EXT4_BG_BLOCK_UNINIT    0x0002 /* Block bitmap not in use */
 384 #define EXT4_BG_INODE_ZEROED    0x0004 /* On-disk itable initialized to zero */
 385
 386 /*
 387  * Macro-instructions used to manage group descriptors
 388  */
 389 #define EXT4_MIN_DESC_SIZE              32
 390 #define EXT4_MIN_DESC_SIZE_64BIT        64
 391 #define EXT4_MAX_DESC_SIZE              EXT4_MIN_BLOCK_SIZE
 392 #define EXT4_DESC_SIZE(s)               (EXT4_SB(s)->s_desc_size)
 393 #ifdef __KERNEL__
 394 # define EXT4_BLOCKS_PER_GROUP(s)       (EXT4_SB(s)->s_blocks_per_group)
 395 # define EXT4_CLUSTERS_PER_GROUP(s)     (EXT4_SB(s)->s_clusters_per_group)
 396 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_SB(s)->s_desc_per_block)
 397 # define EXT4_INODES_PER_GROUP(s)       (EXT4_SB(s)->s_inodes_per_group)
 398 # define EXT4_DESC_PER_BLOCK_BITS(s)    (EXT4_SB(s)->s_desc_per_block_bits)
 399 #else
 400 # define EXT4_BLOCKS_PER_GROUP(s)       ((s)->s_blocks_per_group)
 401 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
 402 # define EXT4_INODES_PER_GROUP(s)       ((s)->s_inodes_per_group)
 403 #endif
 404
 405 /*
 406  * Constants relative to the data blocks
 407  */
 408 #define EXT4_NDIR_BLOCKS                12
 409 #define EXT4_IND_BLOCK                  EXT4_NDIR_BLOCKS
 410 #define EXT4_DIND_BLOCK                 (EXT4_IND_BLOCK + 1)
 411 #define EXT4_TIND_BLOCK                 (EXT4_DIND_BLOCK + 1)
 412 #define EXT4_N_BLOCKS                   (EXT4_TIND_BLOCK + 1)
 413
 414 /*
 415  * Inode flags
 416  */
 417 #define EXT4_SECRM_FL                   0x00000001 /* Secure deletion */
 418 #define EXT4_UNRM_FL                    0x00000002 /* Undelete */
 419 #define EXT4_COMPR_FL                   0x00000004 /* Compress file */
 420 #define EXT4_SYNC_FL                    0x00000008 /* Synchronous updates */
 421 #define EXT4_IMMUTABLE_FL               0x00000010 /* Immutable file */
 422 #define EXT4_APPEND_FL                  0x00000020 /* writes to file may only append */
 423 #define EXT4_NODUMP_FL                  0x00000040 /* do not dump file */
 424 #define EXT4_NOATIME_FL                 0x00000080 /* do not update atime */
 425 /* Reserved for compression usage... */
 426 #define EXT4_DIRTY_FL                   0x00000100
 427 #define EXT4_COMPRBLK_FL                0x00000200 /* One or more compressed clusters */
 428 #define EXT4_NOCOMPR_FL                 0x00000400 /* Don't compress */
 429         /* nb: was previously EXT2_ECOMPR_FL */
 430 #define EXT4_ENCRYPT_FL                 0x00000800 /* encrypted file */
 431 /* End compression flags --- maybe not all used */
 432 #define EXT4_INDEX_FL                   0x00001000 /* hash-indexed directory */
 433 #define EXT4_IMAGIC_FL                  0x00002000 /* AFS directory */
 434 #define EXT4_JOURNAL_DATA_FL            0x00004000 /* file data should be journaled */
 435 #define EXT4_NOTAIL_FL                  0x00008000 /* file tail should not be merged */
 436 #define EXT4_DIRSYNC_FL                 0x00010000 /* dirsync behaviour (directories only) */
 437 #define EXT4_TOPDIR_FL                  0x00020000 /* Top of directory hierarchies*/
 438 #define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
 439 #define EXT4_EXTENTS_FL                 0x00080000 /* Inode uses extents */
 440 #define EXT4_VERITY_FL                  0x00100000 /* Verity protected inode */
 441 #define EXT4_EA_INODE_FL                0x00200000 /* Inode used for large EA */
 442 /* 0x00400000 was formerly EXT4_EOFBLOCKS_FL */
 443
 444 #define EXT4_DAX_FL                     0x02000000 /* Inode is DAX */
 445
 446 #define EXT4_INLINE_DATA_FL             0x10000000 /* Inode has inline data. */
 447 #define EXT4_PROJINHERIT_FL             0x20000000 /* Create with parents projid */
 448 #define EXT4_CASEFOLD_FL                0x40000000 /* Casefolded directory */
 449 #define EXT4_RESERVED_FL                0x80000000 /* reserved for ext4 lib */
 450
 451 /* User modifiable flags */
 452 #define EXT4_FL_USER_MODIFIABLE         (EXT4_SECRM_FL | \
 453                                          EXT4_UNRM_FL | \
 454                                          EXT4_COMPR_FL | \
 455                                          EXT4_SYNC_FL | \
 456                                          EXT4_IMMUTABLE_FL | \
 457                                          EXT4_APPEND_FL | \
 458                                          EXT4_NODUMP_FL | \
 459                                          EXT4_NOATIME_FL | \
 460                                          EXT4_JOURNAL_DATA_FL | \
 461                                          EXT4_NOTAIL_FL | \
 462                                          EXT4_DIRSYNC_FL | \
 463                                          EXT4_TOPDIR_FL | \
 464                                          EXT4_EXTENTS_FL | \
 465                                          0x00400000 /* EXT4_EOFBLOCKS_FL */ | \
 466                                          EXT4_DAX_FL | \
 467                                          EXT4_PROJINHERIT_FL | \
 468                                          EXT4_CASEFOLD_FL)
 469
 470 /* User visible flags */
 471 #define EXT4_FL_USER_VISIBLE            (EXT4_FL_USER_MODIFIABLE | \
 472                                          EXT4_DIRTY_FL | \
 473                                          EXT4_COMPRBLK_FL | \
 474                                          EXT4_NOCOMPR_FL | \
 475                                          EXT4_ENCRYPT_FL | \
 476                                          EXT4_INDEX_FL | \
 477                                          EXT4_VERITY_FL | \
 478                                          EXT4_INLINE_DATA_FL)
 479
 480 /* Flags that should be inherited by new inodes from their parent. */
 481 #define EXT4_FL_INHERITED (EXT4_SECRM_FL | EXT4_UNRM_FL | EXT4_COMPR_FL |\
 482                            EXT4_SYNC_FL | EXT4_NODUMP_FL | EXT4_NOATIME_FL |\
 483                            EXT4_NOCOMPR_FL | EXT4_JOURNAL_DATA_FL |\
 484                            EXT4_NOTAIL_FL | EXT4_DIRSYNC_FL |\
 485                            EXT4_PROJINHERIT_FL | EXT4_CASEFOLD_FL |\
 486                            EXT4_DAX_FL)
 487
 488 /* Flags that are appropriate for regular files (all but dir-specific ones). */
 489 #define EXT4_REG_FLMASK (~(EXT4_DIRSYNC_FL | EXT4_TOPDIR_FL | EXT4_CASEFOLD_FL |\
 490                            EXT4_PROJINHERIT_FL))
 491
 492 /* Flags that are appropriate for non-directories/regular files. */
 493 #define EXT4_OTHER_FLMASK (EXT4_NODUMP_FL | EXT4_NOATIME_FL)
 494
 495 /* The only flags that should be swapped */
 496 #define EXT4_FL_SHOULD_SWAP (EXT4_HUGE_FILE_FL | EXT4_EXTENTS_FL)
 497
 498 /* Flags which are mutually exclusive to DAX */
 499 #define EXT4_DAX_MUT_EXCL (EXT4_VERITY_FL | EXT4_ENCRYPT_FL |\
 500                            EXT4_JOURNAL_DATA_FL | EXT4_INLINE_DATA_FL)
 501
 502 /* Mask out flags that are inappropriate for the given type of inode. */
 503 static inline __u32 ext4_mask_flags(umode_t mode, __u32 flags)
 504 {
 505         if (S_ISDIR(mode))
 506                 return flags;
 507         else if (S_ISREG(mode))
 508                 return flags & EXT4_REG_FLMASK;
 509         else
 510                 return flags & EXT4_OTHER_FLMASK;
 511 }
 512
 513 /*
 514  * Inode flags used for atomic set/get
 515  */
 516 enum {
 517         EXT4_INODE_SECRM        = 0,    /* Secure deletion */
 518         EXT4_INODE_UNRM         = 1,    /* Undelete */
 519         EXT4_INODE_COMPR        = 2,    /* Compress file */
 520         EXT4_INODE_SYNC         = 3,    /* Synchronous updates */
 521         EXT4_INODE_IMMUTABLE    = 4,    /* Immutable file */
 522         EXT4_INODE_APPEND       = 5,    /* writes to file may only append */
 523         EXT4_INODE_NODUMP       = 6,    /* do not dump file */
 524         EXT4_INODE_NOATIME      = 7,    /* do not update atime */
 525 /* Reserved for compression usage... */
 526         EXT4_INODE_DIRTY        = 8,
 527         EXT4_INODE_COMPRBLK     = 9,    /* One or more compressed clusters */
 528         EXT4_INODE_NOCOMPR      = 10,   /* Don't compress */
 529         EXT4_INODE_ENCRYPT      = 11,   /* Encrypted file */
 530 /* End compression flags --- maybe not all used */
 531         EXT4_INODE_INDEX        = 12,   /* hash-indexed directory */
 532         EXT4_INODE_IMAGIC       = 13,   /* AFS directory */
 533         EXT4_INODE_JOURNAL_DATA = 14,   /* file data should be journaled */
 534         EXT4_INODE_NOTAIL       = 15,   /* file tail should not be merged */
 535         EXT4_INODE_DIRSYNC      = 16,   /* dirsync behaviour (directories only) */
 536         EXT4_INODE_TOPDIR       = 17,   /* Top of directory hierarchies*/
 537         EXT4_INODE_HUGE_FILE    = 18,   /* Set to each huge file */
 538         EXT4_INODE_EXTENTS      = 19,   /* Inode uses extents */
 539         EXT4_INODE_VERITY       = 20,   /* Verity protected inode */
 540         EXT4_INODE_EA_INODE     = 21,   /* Inode used for large EA */
 541 /* 22 was formerly EXT4_INODE_EOFBLOCKS */
 542         EXT4_INODE_DAX          = 25,   /* Inode is DAX */
 543         EXT4_INODE_INLINE_DATA  = 28,   /* Data in inode. */
 544         EXT4_INODE_PROJINHERIT  = 29,   /* Create with parents projid */
 545         EXT4_INODE_CASEFOLD     = 30,   /* Casefolded directory */
 546         EXT4_INODE_RESERVED     = 31,   /* reserved for ext4 lib */
 547 };
 548
 549 /*
 550  * Since it's pretty easy to mix up bit numbers and hex values, we use a
 551  * build-time check to make sure that EXT4_XXX_FL is consistent with respect to
 552  * EXT4_INODE_XXX. If all is well, the macros will be dropped, so, it won't cost
 553  * any extra space in the compiled kernel image, otherwise, the build will fail.
 554  * It's important that these values are the same, since we are using
 555  * EXT4_INODE_XXX to test for flag values, but EXT4_XXX_FL must be consistent
 556  * with the values of FS_XXX_FL defined in include/linux/fs.h and the on-disk
 557  * values found in ext2, ext3 and ext4 filesystems, and of course the values
 558  * defined in e2fsprogs.
 559  *
 560  * It's not paranoia if the Murphy's Law really *is* out to get you.  :-)
 561  */
 562 #define TEST_FLAG_VALUE(FLAG) (EXT4_##FLAG##_FL == (1 << EXT4_INODE_##FLAG))
 563 #define CHECK_FLAG_VALUE(FLAG) BUILD_BUG_ON(!TEST_FLAG_VALUE(FLAG))
 564
 565 static inline void ext4_check_flag_values(void)
 566 {
 567         CHECK_FLAG_VALUE(SECRM);
 568         CHECK_FLAG_VALUE(UNRM);
 569         CHECK_FLAG_VALUE(COMPR);
 570         CHECK_FLAG_VALUE(SYNC);
 571         CHECK_FLAG_VALUE(IMMUTABLE);
 572         CHECK_FLAG_VALUE(APPEND);
 573         CHECK_FLAG_VALUE(NODUMP);
 574         CHECK_FLAG_VALUE(NOATIME);
 575         CHECK_FLAG_VALUE(DIRTY);
 576         CHECK_FLAG_VALUE(COMPRBLK);
 577         CHECK_FLAG_VALUE(NOCOMPR);
 578         CHECK_FLAG_VALUE(ENCRYPT);
 579         CHECK_FLAG_VALUE(INDEX);
 580         CHECK_FLAG_VALUE(IMAGIC);
 581         CHECK_FLAG_VALUE(JOURNAL_DATA);
 582         CHECK_FLAG_VALUE(NOTAIL);
 583         CHECK_FLAG_VALUE(DIRSYNC);
 584         CHECK_FLAG_VALUE(TOPDIR);
 585         CHECK_FLAG_VALUE(HUGE_FILE);
 586         CHECK_FLAG_VALUE(EXTENTS);
 587         CHECK_FLAG_VALUE(VERITY);
 588         CHECK_FLAG_VALUE(EA_INODE);
 589         CHECK_FLAG_VALUE(INLINE_DATA);
 590         CHECK_FLAG_VALUE(PROJINHERIT);
 591         CHECK_FLAG_VALUE(CASEFOLD);
 592         CHECK_FLAG_VALUE(RESERVED);
 593 }
 594
 595 /* Used to pass group descriptor data when online resize is done */
 596 struct ext4_new_group_input {
 597         __u32 group;            /* Group number for this data */
 598         __u64 block_bitmap;     /* Absolute block number of block bitmap */
 599         __u64 inode_bitmap;     /* Absolute block number of inode bitmap */
 600         __u64 inode_table;      /* Absolute block number of inode table start */
 601         __u32 blocks_count;     /* Total number of blocks in this group */
 602         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
 603         __u16 unused;
 604 };
 605
 606 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
 607 struct compat_ext4_new_group_input {
 608         u32 group;
 609         compat_u64 block_bitmap;
 610         compat_u64 inode_bitmap;
 611         compat_u64 inode_table;
 612         u32 blocks_count;
 613         u16 reserved_blocks;
 614         u16 unused;
 615 };
 616 #endif
 617
 618 /* The struct ext4_new_group_input in kernel space, with free_blocks_count */
 619 struct ext4_new_group_data {
 620         __u32 group;
 621         __u64 block_bitmap;
 622         __u64 inode_bitmap;
 623         __u64 inode_table;
 624         __u32 blocks_count;
 625         __u16 reserved_blocks;
 626         __u16 mdata_blocks;
 627         __u32 free_clusters_count;
 628 };
 629
 630 /* Indexes used to index group tables in ext4_new_group_data */
 631 enum {
 632         BLOCK_BITMAP = 0,       /* block bitmap */
 633         INODE_BITMAP,           /* inode bitmap */
 634         INODE_TABLE,            /* inode tables */
 635         GROUP_TABLE_COUNT,
 636 };
 637
 638 /*
 639  * Flags used by ext4_map_blocks()
 640  */
 641         /* Allocate any needed blocks and/or convert an unwritten
 642            extent to be an initialized ext4 */
 643 #define EXT4_GET_BLOCKS_CREATE                  0x0001
 644         /* Request the creation of an unwritten extent */
 645 #define EXT4_GET_BLOCKS_UNWRIT_EXT              0x0002
 646 #define EXT4_GET_BLOCKS_CREATE_UNWRIT_EXT       (EXT4_GET_BLOCKS_UNWRIT_EXT|\
 647                                                  EXT4_GET_BLOCKS_CREATE)
 648         /* Caller is from the delayed allocation writeout path
 649          * finally doing the actual allocation of delayed blocks */
 650 #define EXT4_GET_BLOCKS_DELALLOC_RESERVE        0x0004
 651         /* caller is from the direct IO path, request to creation of an
 652         unwritten extents if not allocated, split the unwritten
 653         extent if blocks has been preallocated already*/
 654 #define EXT4_GET_BLOCKS_PRE_IO                  0x0008
 655 #define EXT4_GET_BLOCKS_CONVERT                 0x0010
 656 #define EXT4_GET_BLOCKS_IO_CREATE_EXT           (EXT4_GET_BLOCKS_PRE_IO|\
 657                                          EXT4_GET_BLOCKS_CREATE_UNWRIT_EXT)
 658         /* Convert extent to initialized after IO complete */
 659 #define EXT4_GET_BLOCKS_IO_CONVERT_EXT          (EXT4_GET_BLOCKS_CONVERT|\
 660                                          EXT4_GET_BLOCKS_CREATE_UNWRIT_EXT)
 661         /* Eventual metadata allocation (due to growing extent tree)
 662          * should not fail, so try to use reserved blocks for that.*/
 663 #define EXT4_GET_BLOCKS_METADATA_NOFAIL         0x0020
 664         /* Don't normalize allocation size (used for fallocate) */
 665 #define EXT4_GET_BLOCKS_NO_NORMALIZE            0x0040
 666         /* Convert written extents to unwritten */
 667 #define EXT4_GET_BLOCKS_CONVERT_UNWRITTEN       0x0100
 668         /* Write zeros to newly created written extents */
 669 #define EXT4_GET_BLOCKS_ZERO                    0x0200
 670 #define EXT4_GET_BLOCKS_CREATE_ZERO             (EXT4_GET_BLOCKS_CREATE |\
 671                                         EXT4_GET_BLOCKS_ZERO)
 672         /* Caller will submit data before dropping transaction handle. This
 673          * allows jbd2 to avoid submitting data before commit. */
 674 #define EXT4_GET_BLOCKS_IO_SUBMIT               0x0400
 675
 676 /*
 677  * The bit position of these flags must not overlap with any of the
 678  * EXT4_GET_BLOCKS_*.  They are used by ext4_find_extent(),
 679  * read_extent_tree_block(), ext4_split_extent_at(),
 680  * ext4_ext_insert_extent(), and ext4_ext_create_new_leaf().
 681  * EXT4_EX_NOCACHE is used to indicate that the we shouldn't be
 682  * caching the extents when reading from the extent tree while a
 683  * truncate or punch hole operation is in progress.
 684  */
 685 #define EXT4_EX_NOCACHE                         0x40000000
 686 #define EXT4_EX_FORCE_CACHE                     0x20000000
 687 #define EXT4_EX_NOFAIL                          0x10000000
 688
 689 /*
 690  * Flags used by ext4_free_blocks
 691  */
 692 #define EXT4_FREE_BLOCKS_METADATA               0x0001
 693 #define EXT4_FREE_BLOCKS_FORGET                 0x0002
 694 #define EXT4_FREE_BLOCKS_VALIDATED              0x0004
 695 #define EXT4_FREE_BLOCKS_NO_QUOT_UPDATE         0x0008
 696 #define EXT4_FREE_BLOCKS_NOFREE_FIRST_CLUSTER   0x0010
 697 #define EXT4_FREE_BLOCKS_NOFREE_LAST_CLUSTER    0x0020
 698 #define EXT4_FREE_BLOCKS_RERESERVE_CLUSTER      0x0040
 699
 700 /*
 701  * ioctl commands
 702  */
 703 #define EXT4_IOC_GETVERSION             _IOR('f', 3, long)
 704 #define EXT4_IOC_SETVERSION             _IOW('f', 4, long)
 705 #define EXT4_IOC_GETVERSION_OLD         FS_IOC_GETVERSION
 706 #define EXT4_IOC_SETVERSION_OLD         FS_IOC_SETVERSION
 707 #define EXT4_IOC_GETRSVSZ               _IOR('f', 5, long)
 708 #define EXT4_IOC_SETRSVSZ               _IOW('f', 6, long)
 709 #define EXT4_IOC_GROUP_EXTEND           _IOW('f', 7, unsigned long)
 710 #define EXT4_IOC_GROUP_ADD              _IOW('f', 8, struct ext4_new_group_input)
 711 #define EXT4_IOC_MIGRATE                _IO('f', 9)
 712  /* note ioctl 10 reserved for an early version of the FIEMAP ioctl */
 713  /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
 714 #define EXT4_IOC_ALLOC_DA_BLKS          _IO('f', 12)
 715 #define EXT4_IOC_MOVE_EXT               _IOWR('f', 15, struct move_extent)
 716 #define EXT4_IOC_RESIZE_FS              _IOW('f', 16, __u64)
 717 #define EXT4_IOC_SWAP_BOOT              _IO('f', 17)
 718 #define EXT4_IOC_PRECACHE_EXTENTS       _IO('f', 18)
 719 /* ioctl codes 19--39 are reserved for fscrypt */
 720 #define EXT4_IOC_CLEAR_ES_CACHE         _IO('f', 40)
 721 #define EXT4_IOC_GETSTATE               _IOW('f', 41, __u32)
 722 #define EXT4_IOC_GET_ES_CACHE           _IOWR('f', 42, struct fiemap)
 723 #define EXT4_IOC_CHECKPOINT             _IOW('f', 43, __u32)
 724
 725 #define EXT4_IOC_SHUTDOWN _IOR ('X', 125, __u32)
 726
 727 /*
 728  * Flags for going down operation
 729  */
 730 #define EXT4_GOING_FLAGS_DEFAULT                0x0     /* going down */
 731 #define EXT4_GOING_FLAGS_LOGFLUSH               0x1     /* flush log but not data */
 732 #define EXT4_GOING_FLAGS_NOLOGFLUSH             0x2     /* don't flush log nor data */
 733
 734 /*
 735  * Flags returned by EXT4_IOC_GETSTATE
 736  *
 737  * We only expose to userspace a subset of the state flags in
 738  * i_state_flags
 739  */
 740 #define EXT4_STATE_FLAG_EXT_PRECACHED   0x00000001
 741 #define EXT4_STATE_FLAG_NEW             0x00000002
 742 #define EXT4_STATE_FLAG_NEWENTRY        0x00000004
 743 #define EXT4_STATE_FLAG_DA_ALLOC_CLOSE  0x00000008
 744
 745 /* flags for ioctl EXT4_IOC_CHECKPOINT */
 746 #define EXT4_IOC_CHECKPOINT_FLAG_DISCARD        0x1
 747 #define EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT        0x2
 748 #define EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN        0x4
 749 #define EXT4_IOC_CHECKPOINT_FLAG_VALID          (EXT4_IOC_CHECKPOINT_FLAG_DISCARD | \
 750                                                 EXT4_IOC_CHECKPOINT_FLAG_ZEROOUT | \
 751                                                 EXT4_IOC_CHECKPOINT_FLAG_DRY_RUN)
 752
 753 #if defined(__KERNEL__) && defined(CONFIG_COMPAT)
 754 /*
 755  * ioctl commands in 32 bit emulation
 756  */
 757 #define EXT4_IOC32_GETVERSION           _IOR('f', 3, int)
 758 #define EXT4_IOC32_SETVERSION           _IOW('f', 4, int)
 759 #define EXT4_IOC32_GETRSVSZ             _IOR('f', 5, int)
 760 #define EXT4_IOC32_SETRSVSZ             _IOW('f', 6, int)
 761 #define EXT4_IOC32_GROUP_EXTEND         _IOW('f', 7, unsigned int)
 762 #define EXT4_IOC32_GROUP_ADD            _IOW('f', 8, struct compat_ext4_new_group_input)
 763 #define EXT4_IOC32_GETVERSION_OLD       FS_IOC32_GETVERSION
 764 #define EXT4_IOC32_SETVERSION_OLD       FS_IOC32_SETVERSION
 765 #endif
 766
 767 /*
 768  * Returned by EXT4_IOC_GET_ES_CACHE as an additional possible flag.
 769  * It indicates that the entry in extent status cache is for a hole.
 770  */
 771 #define EXT4_FIEMAP_EXTENT_HOLE         0x08000000
 772
 773 /* Max physical block we can address w/o extents */
 774 #define EXT4_MAX_BLOCK_FILE_PHYS        0xFFFFFFFF
 775
 776 /* Max logical block we can support */
 777 #define EXT4_MAX_LOGICAL_BLOCK          0xFFFFFFFE
 778
 779 /*
 780  * Structure of an inode on the disk
 781  */
 782 struct ext4_inode {
 783         __le16  i_mode;         /* File mode */
 784         __le16  i_uid;          /* Low 16 bits of Owner Uid */
 785         __le32  i_size_lo;      /* Size in bytes */
 786         __le32  i_atime;        /* Access time */
 787         __le32  i_ctime;        /* Inode Change time */
 788         __le32  i_mtime;        /* Modification time */
 789         __le32  i_dtime;        /* Deletion Time */
 790         __le16  i_gid;          /* Low 16 bits of Group Id */
 791         __le16  i_links_count;  /* Links count */
 792         __le32  i_blocks_lo;    /* Blocks count */
 793         __le32  i_flags;        /* File flags */
 794         union {
 795                 struct {
 796                         __le32  l_i_version;
 797                 } linux1;
 798                 struct {
 799                         __u32  h_i_translator;
 800                 } hurd1;
 801                 struct {
 802                         __u32  m_i_reserved1;
 803                 } masix1;
 804         } osd1;                         /* OS dependent 1 */
 805         __le32  i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
 806         __le32  i_generation;   /* File version (for NFS) */
 807         __le32  i_file_acl_lo;  /* File ACL */
 808         __le32  i_size_high;
 809         __le32  i_obso_faddr;   /* Obsoleted fragment address */
 810         union {
 811                 struct {
 812                         __le16  l_i_blocks_high; /* were l_i_reserved1 */
 813                         __le16  l_i_file_acl_high;
 814                         __le16  l_i_uid_high;   /* these 2 fields */
 815                         __le16  l_i_gid_high;   /* were reserved2[0] */
 816                         __le16  l_i_checksum_lo;/* crc32c(uuid+inum+inode) LE */
 817                         __le16  l_i_reserved;
 818                 } linux2;
 819                 struct {
 820                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
 821                         __u16   h_i_mode_high;
 822                         __u16   h_i_uid_high;
 823                         __u16   h_i_gid_high;
 824                         __u32   h_i_author;
 825                 } hurd2;
 826                 struct {
 827                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
 828                         __le16  m_i_file_acl_high;
 829                         __u32   m_i_reserved2[2];
 830                 } masix2;
 831         } osd2;                         /* OS dependent 2 */
 832         __le16  i_extra_isize;
 833         __le16  i_checksum_hi;  /* crc32c(uuid+inum+inode) BE */
 834         __le32  i_ctime_extra;  /* extra Change time      (nsec << 2 | epoch) */
 835         __le32  i_mtime_extra;  /* extra Modification time(nsec << 2 | epoch) */
 836         __le32  i_atime_extra;  /* extra Access time      (nsec << 2 | epoch) */
 837         __le32  i_crtime;       /* File Creation time */
 838         __le32  i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
 839         __le32  i_version_hi;   /* high 32 bits for 64-bit version */
 840         __le32  i_projid;       /* Project ID */
 841 };
 842
 843 struct move_extent {
 844         __u32 reserved;         /* should be zero */
 845         __u32 donor_fd;         /* donor file descriptor */
 846         __u64 orig_start;       /* logical start offset in block for orig */
 847         __u64 donor_start;      /* logical start offset in block for donor */
 848         __u64 len;              /* block length to be moved */
 849         __u64 moved_len;        /* moved block length */
 850 };
 851
 852 #define EXT4_EPOCH_BITS 2
 853 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
 854 #define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)
 855
 856 /*
 857  * Extended fields will fit into an inode if the filesystem was formatted
 858  * with large inodes (-I 256 or larger) and there are not currently any EAs
 859  * consuming all of the available space. For new inodes we always reserve
 860  * enough space for the kernel's known extended fields, but for inodes
 861  * created with an old kernel this might not have been the case. None of
 862  * the extended inode fields is critical for correct filesystem operation.
 863  * This macro checks if a certain field fits in the inode. Note that
 864  * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
 865  */
 866 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field)   \
 867         ((offsetof(typeof(*ext4_inode), field) +        \
 868           sizeof((ext4_inode)->field))                  \
 869         <= (EXT4_GOOD_OLD_INODE_SIZE +                  \
 870             (einode)->i_extra_isize))                   \
 871
 872 /*
 873  * We use an encoding that preserves the times for extra epoch "00":
 874  *
 875  * extra  msb of                         adjust for signed
 876  * epoch  32-bit                         32-bit tv_sec to
 877  * bits   time    decoded 64-bit tv_sec  64-bit tv_sec      valid time range
 878  * 0 0    1    -0x80000000..-0x00000001  0x000000000 1901-12-13..1969-12-31
 879  * 0 0    0    0x000000000..0x07fffffff  0x000000000 1970-01-01..2038-01-19
 880  * 0 1    1    0x080000000..0x0ffffffff  0x100000000 2038-01-19..2106-02-07
 881  * 0 1    0    0x100000000..0x17fffffff  0x100000000 2106-02-07..2174-02-25
 882  * 1 0    1    0x180000000..0x1ffffffff  0x200000000 2174-02-25..2242-03-16
 883  * 1 0    0    0x200000000..0x27fffffff  0x200000000 2242-03-16..2310-04-04
 884  * 1 1    1    0x280000000..0x2ffffffff  0x300000000 2310-04-04..2378-04-22
 885  * 1 1    0    0x300000000..0x37fffffff  0x300000000 2378-04-22..2446-05-10
 886  *
 887  * Note that previous versions of the kernel on 64-bit systems would
 888  * incorrectly use extra epoch bits 1,1 for dates between 1901 and
 889  * 1970.  e2fsck will correct this, assuming that it is run on the
 890  * affected filesystem before 2242.
 891  */
 892
 893 static inline __le32 ext4_encode_extra_time(struct timespec64 *time)
 894 {
 895         u32 extra =((time->tv_sec - (s32)time->tv_sec) >> 32) & EXT4_EPOCH_MASK;
 896         return cpu_to_le32(extra | (time->tv_nsec << EXT4_EPOCH_BITS));
 897 }
 898
 899 static inline void ext4_decode_extra_time(struct timespec64 *time,
 900                                           __le32 extra)
 901 {
 902         if (unlikely(extra & cpu_to_le32(EXT4_EPOCH_MASK)))
 903                 time->tv_sec += (u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK) << 32;
 904         time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> EXT4_EPOCH_BITS;
 905 }
 906
 907 #define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode)                           \
 908 do {                                                                            \
 909         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     {\
 910                 (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec);        \
 911                 (raw_inode)->xtime ## _extra =                                  \
 912                                 ext4_encode_extra_time(&(inode)->xtime);        \
 913                 }                                                               \
 914         else    \
 915                 (raw_inode)->xtime = cpu_to_le32(clamp_t(int32_t, (inode)->xtime.tv_sec, S32_MIN, S32_MAX));    \
 916 } while (0)
 917
 918 #define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode)                        \
 919 do {                                                                           \
 920         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
 921                 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec);      \
 922         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
 923                 (raw_inode)->xtime ## _extra =                                 \
 924                                 ext4_encode_extra_time(&(einode)->xtime);      \
 925 } while (0)
 926
 927 #define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode)                           \
 928 do {                                                                            \
 929         (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime);        \
 930         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) {    \
 931                 ext4_decode_extra_time(&(inode)->xtime,                         \
 932                                        raw_inode->xtime ## _extra);             \
 933                 }                                                               \
 934         else                                                                    \
 935                 (inode)->xtime.tv_nsec = 0;                                     \
 936 } while (0)
 937
 938
 939 #define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode)                        \
 940 do {                                                                           \
 941         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
 942                 (einode)->xtime.tv_sec =                                       \
 943                         (signed)le32_to_cpu((raw_inode)->xtime);               \
 944         else                                                                   \
 945                 (einode)->xtime.tv_sec = 0;                                    \
 946         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
 947                 ext4_decode_extra_time(&(einode)->xtime,                       \
 948                                        raw_inode->xtime ## _extra);            \
 949         else                                                                   \
 950                 (einode)->xtime.tv_nsec = 0;                                   \
 951 } while (0)
 952
 953 #define i_disk_version osd1.linux1.l_i_version
 954
 955 #if defined(__KERNEL__) || defined(__linux__)
 956 #define i_reserved1     osd1.linux1.l_i_reserved1
 957 #define i_file_acl_high osd2.linux2.l_i_file_acl_high
 958 #define i_blocks_high   osd2.linux2.l_i_blocks_high
 959 #define i_uid_low       i_uid
 960 #define i_gid_low       i_gid
 961 #define i_uid_high      osd2.linux2.l_i_uid_high
 962 #define i_gid_high      osd2.linux2.l_i_gid_high
 963 #define i_checksum_lo   osd2.linux2.l_i_checksum_lo
 964
 965 #elif defined(__GNU__)
 966
 967 #define i_translator    osd1.hurd1.h_i_translator
 968 #define i_uid_high      osd2.hurd2.h_i_uid_high
 969 #define i_gid_high      osd2.hurd2.h_i_gid_high
 970 #define i_author        osd2.hurd2.h_i_author
 971
 972 #elif defined(__masix__)
 973
 974 #define i_reserved1     osd1.masix1.m_i_reserved1
 975 #define i_file_acl_high osd2.masix2.m_i_file_acl_high
 976 #define i_reserved2     osd2.masix2.m_i_reserved2
 977
 978 #endif /* defined(__KERNEL__) || defined(__linux__) */
 979
 980 #include "extents_status.h"
 981 #include "fast_commit.h"
 982
 983 /*
 984  * Lock subclasses for i_data_sem in the ext4_inode_info structure.
 985  *
 986  * These are needed to avoid lockdep false positives when we need to
 987  * allocate blocks to the quota inode during ext4_map_blocks(), while
 988  * holding i_data_sem for a normal (non-quota) inode.  Since we don't
 989  * do quota tracking for the quota inode, this avoids deadlock (as
 990  * well as infinite recursion, since it isn't turtles all the way
 991  * down...)
 992  *
 993  *  I_DATA_SEM_NORMAL - Used for most inodes
 994  *  I_DATA_SEM_OTHER  - Used by move_inode.c for the second normal inode
 995  *                        where the second inode has larger inode number
 996  *                        than the first
 997  *  I_DATA_SEM_QUOTA  - Used for quota inodes only
 998  */
 999 enum {
1000         I_DATA_SEM_NORMAL = 0,
1001         I_DATA_SEM_OTHER,
1002         I_DATA_SEM_QUOTA,
1003 };
1004
1005
1006 /*
1007  * fourth extended file system inode data in memory
1008  */
1009 struct ext4_inode_info {
1010         __le32  i_data[15];     /* unconverted */
1011         __u32   i_dtime;
1012         ext4_fsblk_t    i_file_acl;
1013
1014         /*
1015          * i_block_group is the number of the block group which contains
1016          * this file's inode.  Constant across the lifetime of the inode,
1017          * it is used for making block allocation decisions - we try to
1018          * place a file's data blocks near its inode block, and new inodes
1019          * near to their parent directory's inode.
1020          */
1021         ext4_group_t    i_block_group;
1022         ext4_lblk_t     i_dir_start_lookup;
1023 #if (BITS_PER_LONG < 64)
1024         unsigned long   i_state_flags;          /* Dynamic state flags */
1025 #endif
1026         unsigned long   i_flags;
1027
1028         /*
1029          * Extended attributes can be read independently of the main file
1030          * data. Taking i_mutex even when reading would cause contention
1031          * between readers of EAs and writers of regular file data, so
1032          * instead we synchronize on xattr_sem when reading or changing
1033          * EAs.
1034          */
1035         struct rw_semaphore xattr_sem;
1036
1037         /*
1038          * Inodes with EXT4_STATE_ORPHAN_FILE use i_orphan_idx. Otherwise
1039          * i_orphan is used.
1040          */
1041         union {
1042                 struct list_head i_orphan;      /* unlinked but open inodes */
1043                 unsigned int i_orphan_idx;      /* Index in orphan file */
1044         };
1045
1046         /* Fast commit related info */
1047
1048         struct list_head i_fc_list;     /*
1049                                          * inodes that need fast commit
1050                                          * protected by sbi->s_fc_lock.
1051                                          */
1052
1053         /* Start of lblk range that needs to be committed in this fast commit */
1054         ext4_lblk_t i_fc_lblk_start;
1055
1056         /* End of lblk range that needs to be committed in this fast commit */
1057         ext4_lblk_t i_fc_lblk_len;
1058
1059         /* Number of ongoing updates on this inode */
1060         atomic_t  i_fc_updates;
1061
1062         /* Fast commit wait queue for this inode */
1063         wait_queue_head_t i_fc_wait;
1064
1065         /* Protect concurrent accesses on i_fc_lblk_start, i_fc_lblk_len */
1066         struct mutex i_fc_lock;
1067
1068         /*
1069          * i_disksize keeps track of what the inode size is ON DISK, not
1070          * in memory.  During truncate, i_size is set to the new size by
1071          * the VFS prior to calling ext4_truncate(), but the filesystem won't
1072          * set i_disksize to 0 until the truncate is actually under way.
1073          *
1074          * The intent is that i_disksize always represents the blocks which
1075          * are used by this file.  This allows recovery to restart truncate
1076          * on orphans if we crash during truncate.  We actually write i_disksize
1077          * into the on-disk inode when writing inodes out, instead of i_size.
1078          *
1079          * The only time when i_disksize and i_size may be different is when
1080          * a truncate is in progress.  The only things which change i_disksize
1081          * are ext4_get_block (growth) and ext4_truncate (shrinkth).
1082          */
1083         loff_t  i_disksize;
1084
1085         /*
1086          * i_data_sem is for serialising ext4_truncate() against
1087          * ext4_getblock().  In the 2.4 ext2 design, great chunks of inode's
1088          * data tree are chopped off during truncate. We can't do that in
1089          * ext4 because whenever we perform intermediate commits during
1090          * truncate, the inode and all the metadata blocks *must* be in a
1091          * consistent state which allows truncation of the orphans to restart
1092          * during recovery.  Hence we must fix the get_block-vs-truncate race
1093          * by other means, so we have i_data_sem.
1094          */
1095         struct rw_semaphore i_data_sem;
1096         struct inode vfs_inode;
1097         struct jbd2_inode *jinode;
1098
1099         spinlock_t i_raw_lock;  /* protects updates to the raw inode */
1100
1101         /*
1102          * File creation time. Its function is same as that of
1103          * struct timespec64 i_{a,c,m}time in the generic inode.
1104          */
1105         struct timespec64 i_crtime;
1106
1107         /* mballoc */
1108         atomic_t i_prealloc_active;
1109         struct list_head i_prealloc_list;
1110         spinlock_t i_prealloc_lock;
1111
1112         /* extents status tree */
1113         struct ext4_es_tree i_es_tree;
1114         rwlock_t i_es_lock;
1115         struct list_head i_es_list;
1116         unsigned int i_es_all_nr;       /* protected by i_es_lock */
1117         unsigned int i_es_shk_nr;       /* protected by i_es_lock */
1118         ext4_lblk_t i_es_shrink_lblk;   /* Offset where we start searching for
1119                                            extents to shrink. Protected by
1120                                            i_es_lock  */
1121
1122         /* ialloc */
1123         ext4_group_t    i_last_alloc_group;
1124
1125         /* allocation reservation info for delalloc */
1126         /* In case of bigalloc, this refer to clusters rather than blocks */
1127         unsigned int i_reserved_data_blocks;
1128
1129         /* pending cluster reservations for bigalloc file systems */
1130         struct ext4_pending_tree i_pending_tree;
1131
1132         /* on-disk additional length */
1133         __u16 i_extra_isize;
1134
1135         /* Indicate the inline data space. */
1136         u16 i_inline_off;
1137         u16 i_inline_size;
1138
1139 #ifdef CONFIG_QUOTA
1140         /* quota space reservation, managed internally by quota code */
1141         qsize_t i_reserved_quota;
1142 #endif
1143
1144         /* Lock protecting lists below */
1145         spinlock_t i_completed_io_lock;
1146         /*
1147          * Completed IOs that need unwritten extents handling and have
1148          * transaction reserved
1149          */
1150         struct list_head i_rsv_conversion_list;
1151         struct work_struct i_rsv_conversion_work;
1152         atomic_t i_unwritten; /* Nr. of inflight conversions pending */
1153
1154         spinlock_t i_block_reservation_lock;
1155
1156         /*
1157          * Transactions that contain inode's metadata needed to complete
1158          * fsync and fdatasync, respectively.
1159          */
1160         tid_t i_sync_tid;
1161         tid_t i_datasync_tid;
1162
1163 #ifdef CONFIG_QUOTA
1164         struct dquot *i_dquot[MAXQUOTAS];
1165 #endif
1166
1167         /* Precomputed uuid+inum+igen checksum for seeding inode checksums */
1168         __u32 i_csum_seed;
1169
1170         kprojid_t i_projid;
1171 };
1172
1173 /*
1174  * File system states
1175  */
1176 #define EXT4_VALID_FS                   0x0001  /* Unmounted cleanly */
1177 #define EXT4_ERROR_FS                   0x0002  /* Errors detected */
1178 #define EXT4_ORPHAN_FS                  0x0004  /* Orphans being recovered */
1179 #define EXT4_FC_REPLAY                  0x0020  /* Fast commit replay ongoing */
1180
1181 /*
1182  * Misc. filesystem flags
1183  */
1184 #define EXT2_FLAGS_SIGNED_HASH          0x0001  /* Signed dirhash in use */
1185 #define EXT2_FLAGS_UNSIGNED_HASH        0x0002  /* Unsigned dirhash in use */
1186 #define EXT2_FLAGS_TEST_FILESYS         0x0004  /* to test development code */
1187
1188 /*
1189  * Mount flags set via mount options or defaults
1190  */
1191 #define EXT4_MOUNT_NO_MBCACHE           0x00001 /* Do not use mbcache */
1192 #define EXT4_MOUNT_GRPID                0x00004 /* Create files with directory's group */
1193 #define EXT4_MOUNT_DEBUG                0x00008 /* Some debugging messages */
1194 #define EXT4_MOUNT_ERRORS_CONT          0x00010 /* Continue on errors */
1195 #define EXT4_MOUNT_ERRORS_RO            0x00020 /* Remount fs ro on errors */
1196 #define EXT4_MOUNT_ERRORS_PANIC         0x00040 /* Panic on errors */
1197 #define EXT4_MOUNT_ERRORS_MASK          0x00070
1198 #define EXT4_MOUNT_MINIX_DF             0x00080 /* Mimics the Minix statfs */
1199 #define EXT4_MOUNT_NOLOAD               0x00100 /* Don't use existing journal*/
1200 #ifdef CONFIG_FS_DAX
1201 #define EXT4_MOUNT_DAX_ALWAYS           0x00200 /* Direct Access */
1202 #else
1203 #define EXT4_MOUNT_DAX_ALWAYS           0
1204 #endif
1205 #define EXT4_MOUNT_DATA_FLAGS           0x00C00 /* Mode for data writes: */
1206 #define EXT4_MOUNT_JOURNAL_DATA         0x00400 /* Write data to journal */
1207 #define EXT4_MOUNT_ORDERED_DATA         0x00800 /* Flush data before commit */
1208 #define EXT4_MOUNT_WRITEBACK_DATA       0x00C00 /* No data ordering */
1209 #define EXT4_MOUNT_UPDATE_JOURNAL       0x01000 /* Update the journal format */
1210 #define EXT4_MOUNT_NO_UID32             0x02000  /* Disable 32-bit UIDs */
1211 #define EXT4_MOUNT_XATTR_USER           0x04000 /* Extended user attributes */
1212 #define EXT4_MOUNT_POSIX_ACL            0x08000 /* POSIX Access Control Lists */
1213 #define EXT4_MOUNT_NO_AUTO_DA_ALLOC     0x10000 /* No auto delalloc mapping */
1214 #define EXT4_MOUNT_BARRIER              0x20000 /* Use block barriers */
1215 #define EXT4_MOUNT_QUOTA                0x40000 /* Some quota option set */
1216 #define EXT4_MOUNT_USRQUOTA             0x80000 /* "old" user quota,
1217                                                  * enable enforcement for hidden
1218                                                  * quota files */
1219 #define EXT4_MOUNT_GRPQUOTA             0x100000 /* "old" group quota, enable
1220                                                   * enforcement for hidden quota
1221                                                   * files */
1222 #define EXT4_MOUNT_PRJQUOTA             0x200000 /* Enable project quota
1223                                                   * enforcement */
1224 #define EXT4_MOUNT_DIOREAD_NOLOCK       0x400000 /* Enable support for dio read nolocking */
1225 #define EXT4_MOUNT_JOURNAL_CHECKSUM     0x800000 /* Journal checksums */
1226 #define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT 0x1000000 /* Journal Async Commit */
1227 #define EXT4_MOUNT_WARN_ON_ERROR        0x2000000 /* Trigger WARN_ON on error */
1228 #define EXT4_MOUNT_NO_PREFETCH_BLOCK_BITMAPS 0x4000000
1229 #define EXT4_MOUNT_DELALLOC             0x8000000 /* Delalloc support */
1230 #define EXT4_MOUNT_DATA_ERR_ABORT       0x10000000 /* Abort on file data write */
1231 #define EXT4_MOUNT_BLOCK_VALIDITY       0x20000000 /* Block validity checking */
1232 #define EXT4_MOUNT_DISCARD              0x40000000 /* Issue DISCARD requests */
1233 #define EXT4_MOUNT_INIT_INODE_TABLE     0x80000000 /* Initialize uninitialized itables */
1234
1235 /*
1236  * Mount flags set either automatically (could not be set by mount option)
1237  * based on per file system feature or property or in special cases such as
1238  * distinguishing between explicit mount option definition and default.
1239  */
1240 #define EXT4_MOUNT2_EXPLICIT_DELALLOC   0x00000001 /* User explicitly
1241                                                       specified delalloc */
1242 #define EXT4_MOUNT2_STD_GROUP_SIZE      0x00000002 /* We have standard group
1243                                                       size of blocksize * 8
1244                                                       blocks */
1245 #define EXT4_MOUNT2_HURD_COMPAT         0x00000004 /* Support HURD-castrated
1246                                                       file systems */
1247 #define EXT4_MOUNT2_EXPLICIT_JOURNAL_CHECKSUM   0x00000008 /* User explicitly
1248                                                 specified journal checksum */
1249
1250 #define EXT4_MOUNT2_JOURNAL_FAST_COMMIT 0x00000010 /* Journal fast commit */
1251 #define EXT4_MOUNT2_DAX_NEVER           0x00000020 /* Do not allow Direct Access */
1252 #define EXT4_MOUNT2_DAX_INODE           0x00000040 /* For printing options only */
1253 #define EXT4_MOUNT2_MB_OPTIMIZE_SCAN    0x00000080 /* Optimize group
1254                                                     * scanning in mballoc
1255                                                     */
1256
1257 #define clear_opt(sb, opt)              EXT4_SB(sb)->s_mount_opt &= \
1258                                                 ~EXT4_MOUNT_##opt
1259 #define set_opt(sb, opt)                EXT4_SB(sb)->s_mount_opt |= \
1260                                                 EXT4_MOUNT_##opt
1261 #define test_opt(sb, opt)               (EXT4_SB(sb)->s_mount_opt & \
1262                                          EXT4_MOUNT_##opt)
1263
1264 #define clear_opt2(sb, opt)             EXT4_SB(sb)->s_mount_opt2 &= \
1265                                                 ~EXT4_MOUNT2_##opt
1266 #define set_opt2(sb, opt)               EXT4_SB(sb)->s_mount_opt2 |= \
1267                                                 EXT4_MOUNT2_##opt
1268 #define test_opt2(sb, opt)              (EXT4_SB(sb)->s_mount_opt2 & \
1269                                          EXT4_MOUNT2_##opt)
1270
1271 #define ext4_test_and_set_bit           __test_and_set_bit_le
1272 #define ext4_set_bit                    __set_bit_le
1273 #define ext4_set_bit_atomic             ext2_set_bit_atomic
1274 #define ext4_test_and_clear_bit         __test_and_clear_bit_le
1275 #define ext4_clear_bit                  __clear_bit_le
1276 #define ext4_clear_bit_atomic           ext2_clear_bit_atomic
1277 #define ext4_test_bit                   test_bit_le
1278 #define ext4_find_next_zero_bit         find_next_zero_bit_le
1279 #define ext4_find_next_bit              find_next_bit_le
1280
1281 extern void ext4_set_bits(void *bm, int cur, int len);
1282
1283 /*
1284  * Maximal mount counts between two filesystem checks
1285  */
1286 #define EXT4_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
1287 #define EXT4_DFL_CHECKINTERVAL          0       /* Don't use interval check */
1288
1289 /*
1290  * Behaviour when detecting errors
1291  */
1292 #define EXT4_ERRORS_CONTINUE            1       /* Continue execution */
1293 #define EXT4_ERRORS_RO                  2       /* Remount fs read-only */
1294 #define EXT4_ERRORS_PANIC               3       /* Panic */
1295 #define EXT4_ERRORS_DEFAULT             EXT4_ERRORS_CONTINUE
1296
1297 /* Metadata checksum algorithm codes */
1298 #define EXT4_CRC32C_CHKSUM              1
1299
1300 /*
1301  * Structure of the super block
1302  */
1303 struct ext4_super_block {
1304 /*00*/  __le32  s_inodes_count;         /* Inodes count */
1305         __le32  s_blocks_count_lo;      /* Blocks count */
1306         __le32  s_r_blocks_count_lo;    /* Reserved blocks count */
1307         __le32  s_free_blocks_count_lo; /* Free blocks count */
1308 /*10*/  __le32  s_free_inodes_count;    /* Free inodes count */
1309         __le32  s_first_data_block;     /* First Data Block */
1310         __le32  s_log_block_size;       /* Block size */
1311         __le32  s_log_cluster_size;     /* Allocation cluster size */
1312 /*20*/  __le32  s_blocks_per_group;     /* # Blocks per group */
1313         __le32  s_clusters_per_group;   /* # Clusters per group */
1314         __le32  s_inodes_per_group;     /* # Inodes per group */
1315         __le32  s_mtime;                /* Mount time */
1316 /*30*/  __le32  s_wtime;                /* Write time */
1317         __le16  s_mnt_count;            /* Mount count */
1318         __le16  s_max_mnt_count;        /* Maximal mount count */
1319         __le16  s_magic;                /* Magic signature */
1320         __le16  s_state;                /* File system state */
1321         __le16  s_errors;               /* Behaviour when detecting errors */
1322         __le16  s_minor_rev_level;      /* minor revision level */
1323 /*40*/  __le32  s_lastcheck;            /* time of last check */
1324         __le32  s_checkinterval;        /* max. time between checks */
1325         __le32  s_creator_os;           /* OS */
1326         __le32  s_rev_level;            /* Revision level */
1327 /*50*/  __le16  s_def_resuid;           /* Default uid for reserved blocks */
1328         __le16  s_def_resgid;           /* Default gid for reserved blocks */
1329         /*
1330          * These fields are for EXT4_DYNAMIC_REV superblocks only.
1331          *
1332          * Note: the difference between the compatible feature set and
1333          * the incompatible feature set is that if there is a bit set
1334          * in the incompatible feature set that the kernel doesn't
1335          * know about, it should refuse to mount the filesystem.
1336          *
1337          * e2fsck's requirements are more strict; if it doesn't know
1338          * about a feature in either the compatible or incompatible
1339          * feature set, it must abort and not try to meddle with
1340          * things it doesn't understand...
1341          */
1342         __le32  s_first_ino;            /* First non-reserved inode */
1343         __le16  s_inode_size;           /* size of inode structure */
1344         __le16  s_block_group_nr;       /* block group # of this superblock */
1345         __le32  s_feature_compat;       /* compatible feature set */
1346 /*60*/  __le32  s_feature_incompat;     /* incompatible feature set */
1347         __le32  s_feature_ro_compat;    /* readonly-compatible feature set */
1348 /*68*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
1349 /*78*/  char    s_volume_name[16];      /* volume name */
1350 /*88*/  char    s_last_mounted[64] __nonstring; /* directory where last mounted */
1351 /*C8*/  __le32  s_algorithm_usage_bitmap; /* For compression */
1352         /*
1353          * Performance hints.  Directory preallocation should only
1354          * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
1355          */
1356         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
1357         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
1358         __le16  s_reserved_gdt_blocks;  /* Per group desc for online growth */
1359         /*
1360          * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
1361          */
1362 /*D0*/  __u8    s_journal_uuid[16];     /* uuid of journal superblock */
1363 /*E0*/  __le32  s_journal_inum;         /* inode number of journal file */
1364         __le32  s_journal_dev;          /* device number of journal file */
1365         __le32  s_last_orphan;          /* start of list of inodes to delete */
1366         __le32  s_hash_seed[4];         /* HTREE hash seed */
1367         __u8    s_def_hash_version;     /* Default hash version to use */
1368         __u8    s_jnl_backup_type;
1369         __le16  s_desc_size;            /* size of group descriptor */
1370 /*100*/ __le32  s_default_mount_opts;
1371         __le32  s_first_meta_bg;        /* First metablock block group */
1372         __le32  s_mkfs_time;            /* When the filesystem was created */
1373         __le32  s_jnl_blocks[17];       /* Backup of the journal inode */
1374         /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
1375 /*150*/ __le32  s_blocks_count_hi;      /* Blocks count */
1376         __le32  s_r_blocks_count_hi;    /* Reserved blocks count */
1377         __le32  s_free_blocks_count_hi; /* Free blocks count */
1378         __le16  s_min_extra_isize;      /* All inodes have at least # bytes */
1379         __le16  s_want_extra_isize;     /* New inodes should reserve # bytes */
1380         __le32  s_flags;                /* Miscellaneous flags */
1381         __le16  s_raid_stride;          /* RAID stride */
1382         __le16  s_mmp_update_interval;  /* # seconds to wait in MMP checking */
1383         __le64  s_mmp_block;            /* Block for multi-mount protection */
1384         __le32  s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
1385         __u8    s_log_groups_per_flex;  /* FLEX_BG group size */
1386         __u8    s_checksum_type;        /* metadata checksum algorithm used */
1387         __u8    s_encryption_level;     /* versioning level for encryption */
1388         __u8    s_reserved_pad;         /* Padding to next 32bits */
1389         __le64  s_kbytes_written;       /* nr of lifetime kilobytes written */
1390         __le32  s_snapshot_inum;        /* Inode number of active snapshot */
1391         __le32  s_snapshot_id;          /* sequential ID of active snapshot */
1392         __le64  s_snapshot_r_blocks_count; /* reserved blocks for active
1393                                               snapshot's future use */
1394         __le32  s_snapshot_list;        /* inode number of the head of the
1395                                            on-disk snapshot list */
1396 #define EXT4_S_ERR_START offsetof(struct ext4_super_block, s_error_count)
1397         __le32  s_error_count;          /* number of fs errors */
1398         __le32  s_first_error_time;     /* first time an error happened */
1399         __le32  s_first_error_ino;      /* inode involved in first error */
1400         __le64  s_first_error_block;    /* block involved of first error */
1401         __u8    s_first_error_func[32] __nonstring;     /* function where the error happened */
1402         __le32  s_first_error_line;     /* line number where error happened */
1403         __le32  s_last_error_time;      /* most recent time of an error */
1404         __le32  s_last_error_ino;       /* inode involved in last error */
1405         __le32  s_last_error_line;      /* line number where error happened */
1406         __le64  s_last_error_block;     /* block involved of last error */
1407         __u8    s_last_error_func[32] __nonstring;      /* function where the error happened */
1408 #define EXT4_S_ERR_END offsetof(struct ext4_super_block, s_mount_opts)
1409         __u8    s_mount_opts[64];
1410         __le32  s_usr_quota_inum;       /* inode for tracking user quota */
1411         __le32  s_grp_quota_inum;       /* inode for tracking group quota */
1412         __le32  s_overhead_clusters;    /* overhead blocks/clusters in fs */
1413         __le32  s_backup_bgs[2];        /* groups with sparse_super2 SBs */
1414         __u8    s_encrypt_algos[4];     /* Encryption algorithms in use  */
1415         __u8    s_encrypt_pw_salt[16];  /* Salt used for string2key algorithm */
1416         __le32  s_lpf_ino;              /* Location of the lost+found inode */
1417         __le32  s_prj_quota_inum;       /* inode for tracking project quota */
1418         __le32  s_checksum_seed;        /* crc32c(uuid) if csum_seed set */
1419         __u8    s_wtime_hi;
1420         __u8    s_mtime_hi;
1421         __u8    s_mkfs_time_hi;
1422         __u8    s_lastcheck_hi;
1423         __u8    s_first_error_time_hi;
1424         __u8    s_last_error_time_hi;
1425         __u8    s_first_error_errcode;
1426         __u8    s_last_error_errcode;
1427         __le16  s_encoding;             /* Filename charset encoding */
1428         __le16  s_encoding_flags;       /* Filename charset encoding flags */
1429         __le32  s_orphan_file_inum;     /* Inode for tracking orphan inodes */
1430         __le32  s_reserved[94];         /* Padding to the end of the block */
1431         __le32  s_checksum;             /* crc32c(superblock) */
1432 };
1433
1434 #define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
1435
1436 #ifdef __KERNEL__
1437
1438 /* Number of quota types we support */
1439 #define EXT4_MAXQUOTAS 3
1440
1441 #define EXT4_ENC_UTF8_12_1      1
1442
1443 /* Types of ext4 journal triggers */
1444 enum ext4_journal_trigger_type {
1445         EXT4_JTR_ORPHAN_FILE,
1446         EXT4_JTR_NONE   /* This must be the last entry for indexing to work! */
1447 };
1448
1449 #define EXT4_JOURNAL_TRIGGER_COUNT EXT4_JTR_NONE
1450
1451 struct ext4_journal_trigger {
1452         struct jbd2_buffer_trigger_type tr_triggers;
1453         struct super_block *sb;
1454 };
1455
1456 static inline struct ext4_journal_trigger *EXT4_TRIGGER(
1457                                 struct jbd2_buffer_trigger_type *trigger)
1458 {
1459         return container_of(trigger, struct ext4_journal_trigger, tr_triggers);
1460 }
1461
1462 #define EXT4_ORPHAN_BLOCK_MAGIC 0x0b10ca04
1463
1464 /* Structure at the tail of orphan block */
1465 struct ext4_orphan_block_tail {
1466         __le32 ob_magic;
1467         __le32 ob_checksum;
1468 };
1469
1470 static inline int ext4_inodes_per_orphan_block(struct super_block *sb)
1471 {
1472         return (sb->s_blocksize - sizeof(struct ext4_orphan_block_tail)) /
1473                         sizeof(u32);
1474 }
1475
1476 struct ext4_orphan_block {
1477         atomic_t ob_free_entries;       /* Number of free orphan entries in block */
1478         struct buffer_head *ob_bh;      /* Buffer for orphan block */
1479 };
1480
1481 /*
1482  * Info about orphan file.
1483  */
1484 struct ext4_orphan_info {
1485         int of_blocks;                  /* Number of orphan blocks in a file */
1486         __u32 of_csum_seed;             /* Checksum seed for orphan file */
1487         struct ext4_orphan_block *of_binfo;     /* Array with info about orphan
1488                                                  * file blocks */
1489 };
1490
1491 /*
1492  * fourth extended-fs super-block data in memory
1493  */
1494 struct ext4_sb_info {
1495         unsigned long s_desc_size;      /* Size of a group descriptor in bytes */
1496         unsigned long s_inodes_per_block;/* Number of inodes per block */
1497         unsigned long s_blocks_per_group;/* Number of blocks in a group */
1498         unsigned long s_clusters_per_group; /* Number of clusters in a group */
1499         unsigned long s_inodes_per_group;/* Number of inodes in a group */
1500         unsigned long s_itb_per_group;  /* Number of inode table blocks per group */
1501         unsigned long s_gdb_count;      /* Number of group descriptor blocks */
1502         unsigned long s_desc_per_block; /* Number of group descriptors per block */
1503         ext4_group_t s_groups_count;    /* Number of groups in the fs */
1504         ext4_group_t s_blockfile_groups;/* Groups acceptable for non-extent files */
1505         unsigned long s_overhead;  /* # of fs overhead clusters */
1506         unsigned int s_cluster_ratio;   /* Number of blocks per cluster */
1507         unsigned int s_cluster_bits;    /* log2 of s_cluster_ratio */
1508         loff_t s_bitmap_maxbytes;       /* max bytes for bitmap files */
1509         struct buffer_head * s_sbh;     /* Buffer containing the super block */
1510         struct ext4_super_block *s_es;  /* Pointer to the super block in the buffer */
1511         struct buffer_head * __rcu *s_group_desc;
1512         unsigned int s_mount_opt;
1513         unsigned int s_mount_opt2;
1514         unsigned long s_mount_flags;
1515         unsigned int s_def_mount_opt;
1516         ext4_fsblk_t s_sb_block;
1517         atomic64_t s_resv_clusters;
1518         kuid_t s_resuid;
1519         kgid_t s_resgid;
1520         unsigned short s_mount_state;
1521         unsigned short s_pad;
1522         int s_addr_per_block_bits;
1523         int s_desc_per_block_bits;
1524         int s_inode_size;
1525         int s_first_ino;
1526         unsigned int s_inode_readahead_blks;
1527         unsigned int s_inode_goal;
1528         u32 s_hash_seed[4];
1529         int s_def_hash_version;
1530         int s_hash_unsigned;    /* 3 if hash should be unsigned, 0 if not */
1531         struct percpu_counter s_freeclusters_counter;
1532         struct percpu_counter s_freeinodes_counter;
1533         struct percpu_counter s_dirs_counter;
1534         struct percpu_counter s_dirtyclusters_counter;
1535         struct percpu_counter s_sra_exceeded_retry_limit;
1536         struct blockgroup_lock *s_blockgroup_lock;
1537         struct proc_dir_entry *s_proc;
1538         struct kobject s_kobj;
1539         struct completion s_kobj_unregister;
1540         struct super_block *s_sb;
1541         struct buffer_head *s_mmp_bh;
1542
1543         /* Journaling */
1544         struct journal_s *s_journal;
1545         unsigned long s_ext4_flags;             /* Ext4 superblock flags */
1546         struct mutex s_orphan_lock;     /* Protects on disk list changes */
1547         struct list_head s_orphan;      /* List of orphaned inodes in on disk
1548                                            list */
1549         struct ext4_orphan_info s_orphan_info;
1550         unsigned long s_commit_interval;
1551         u32 s_max_batch_time;
1552         u32 s_min_batch_time;
1553         struct block_device *s_journal_bdev;
1554 #ifdef CONFIG_QUOTA
1555         /* Names of quota files with journalled quota */
1556         char __rcu *s_qf_names[EXT4_MAXQUOTAS];
1557         int s_jquota_fmt;                       /* Format of quota to use */
1558 #endif
1559         unsigned int s_want_extra_isize; /* New inodes should reserve # bytes */
1560         struct ext4_system_blocks __rcu *s_system_blks;
1561
1562 #ifdef EXTENTS_STATS
1563         /* ext4 extents stats */
1564         unsigned long s_ext_min;
1565         unsigned long s_ext_max;
1566         unsigned long s_depth_max;
1567         spinlock_t s_ext_stats_lock;
1568         unsigned long s_ext_blocks;
1569         unsigned long s_ext_extents;
1570 #endif
1571
1572         /* for buddy allocator */
1573         struct ext4_group_info ** __rcu *s_group_info;
1574         struct inode *s_buddy_cache;
1575         spinlock_t s_md_lock;
1576         unsigned short *s_mb_offsets;
1577         unsigned int *s_mb_maxs;
1578         unsigned int s_group_info_size;
1579         unsigned int s_mb_free_pending;
1580         struct list_head s_freed_data_list;     /* List of blocks to be freed
1581                                                    after commit completed */
1582         struct list_head s_discard_list;
1583         struct work_struct s_discard_work;
1584         atomic_t s_retry_alloc_pending;
1585         struct rb_root s_mb_avg_fragment_size_root;
1586         rwlock_t s_mb_rb_lock;
1587         struct list_head *s_mb_largest_free_orders;
1588         rwlock_t *s_mb_largest_free_orders_locks;
1589
1590         /* tunables */
1591         unsigned long s_stripe;
1592         unsigned int s_mb_max_linear_groups;
1593         unsigned int s_mb_stream_request;
1594         unsigned int s_mb_max_to_scan;
1595         unsigned int s_mb_min_to_scan;
1596         unsigned int s_mb_stats;
1597         unsigned int s_mb_order2_reqs;
1598         unsigned int s_mb_group_prealloc;
1599         unsigned int s_mb_max_inode_prealloc;
1600         unsigned int s_max_dir_size_kb;
1601         /* where last allocation was done - for stream allocation */
1602         unsigned long s_mb_last_group;
1603         unsigned long s_mb_last_start;
1604         unsigned int s_mb_prefetch;
1605         unsigned int s_mb_prefetch_limit;
1606
1607         /* stats for buddy allocator */
1608         atomic_t s_bal_reqs;    /* number of reqs with len > 1 */
1609         atomic_t s_bal_success; /* we found long enough chunks */
1610         atomic_t s_bal_allocated;       /* in blocks */
1611         atomic_t s_bal_ex_scanned;      /* total extents scanned */
1612         atomic_t s_bal_groups_scanned;  /* number of groups scanned */
1613         atomic_t s_bal_goals;   /* goal hits */
1614         atomic_t s_bal_breaks;  /* too long searches */
1615         atomic_t s_bal_2orders; /* 2^order hits */
1616         atomic_t s_bal_cr0_bad_suggestions;
1617         atomic_t s_bal_cr1_bad_suggestions;
1618         atomic64_t s_bal_cX_groups_considered[4];
1619         atomic64_t s_bal_cX_hits[4];
1620         atomic64_t s_bal_cX_failed[4];          /* cX loop didn't find blocks */
1621         atomic_t s_mb_buddies_generated;        /* number of buddies generated */
1622         atomic64_t s_mb_generation_time;
1623         atomic_t s_mb_lost_chunks;
1624         atomic_t s_mb_preallocated;
1625         atomic_t s_mb_discarded;
1626         atomic_t s_lock_busy;
1627
1628         /* locality groups */
1629         struct ext4_locality_group __percpu *s_locality_groups;
1630
1631         /* for write statistics */
1632         unsigned long s_sectors_written_start;
1633         u64 s_kbytes_written;
1634
1635         /* the size of zero-out chunk */
1636         unsigned int s_extent_max_zeroout_kb;
1637
1638         unsigned int s_log_groups_per_flex;
1639         struct flex_groups * __rcu *s_flex_groups;
1640         ext4_group_t s_flex_groups_allocated;
1641
1642         /* workqueue for reserved extent conversions (buffered io) */
1643         struct workqueue_struct *rsv_conversion_wq;
1644
1645         /* timer for periodic error stats printing */
1646         struct timer_list s_err_report;
1647
1648         /* Lazy inode table initialization info */
1649         struct ext4_li_request *s_li_request;
1650         /* Wait multiplier for lazy initialization thread */
1651         unsigned int s_li_wait_mult;
1652
1653         /* Kernel thread for multiple mount protection */
1654         struct task_struct *s_mmp_tsk;
1655
1656         /* record the last minlen when FITRIM is called. */
1657         atomic_t s_last_trim_minblks;
1658
1659         /* Reference to checksum algorithm driver via cryptoapi */
1660         struct crypto_shash *s_chksum_driver;
1661
1662         /* Precomputed FS UUID checksum for seeding other checksums */
1663         __u32 s_csum_seed;
1664
1665         /* Reclaim extents from extent status tree */
1666         struct shrinker s_es_shrinker;
1667         struct list_head s_es_list;     /* List of inodes with reclaimable extents */
1668         long s_es_nr_inode;
1669         struct ext4_es_stats s_es_stats;
1670         struct mb_cache *s_ea_block_cache;
1671         struct mb_cache *s_ea_inode_cache;
1672         spinlock_t s_es_lock ____cacheline_aligned_in_smp;
1673
1674         /* Journal triggers for checksum computation */
1675         struct ext4_journal_trigger s_journal_triggers[EXT4_JOURNAL_TRIGGER_COUNT];
1676
1677         /* Ratelimit ext4 messages. */
1678         struct ratelimit_state s_err_ratelimit_state;
1679         struct ratelimit_state s_warning_ratelimit_state;
1680         struct ratelimit_state s_msg_ratelimit_state;
1681         atomic_t s_warning_count;
1682         atomic_t s_msg_count;
1683
1684         /* Encryption policy for '-o test_dummy_encryption' */
1685         struct fscrypt_dummy_policy s_dummy_enc_policy;
1686
1687         /*
1688          * Barrier between writepages ops and changing any inode's JOURNAL_DATA
1689          * or EXTENTS flag.
1690          */
1691         struct percpu_rw_semaphore s_writepages_rwsem;
1692         struct dax_device *s_daxdev;
1693 #ifdef CONFIG_EXT4_DEBUG
1694         unsigned long s_simulate_fail;
1695 #endif
1696         /* Record the errseq of the backing block device */
1697         errseq_t s_bdev_wb_err;
1698         spinlock_t s_bdev_wb_lock;
1699
1700         /* Information about errors that happened during this mount */
1701         spinlock_t s_error_lock;
1702         int s_add_error_count;
1703         int s_first_error_code;
1704         __u32 s_first_error_line;
1705         __u32 s_first_error_ino;
1706         __u64 s_first_error_block;
1707         const char *s_first_error_func;
1708         time64_t s_first_error_time;
1709         int s_last_error_code;
1710         __u32 s_last_error_line;
1711         __u32 s_last_error_ino;
1712         __u64 s_last_error_block;
1713         const char *s_last_error_func;
1714         time64_t s_last_error_time;
1715         /*
1716          * If we are in a context where we cannot update error information in
1717          * the on-disk superblock, we queue this work to do it.
1718          */
1719         struct work_struct s_error_work;
1720
1721         /* Ext4 fast commit sub transaction ID */
1722         atomic_t s_fc_subtid;
1723
1724         /*
1725          * After commit starts, the main queue gets locked, and the further
1726          * updates get added in the staging queue.
1727          */
1728 #define FC_Q_MAIN       0
1729 #define FC_Q_STAGING    1
1730         struct list_head s_fc_q[2];     /* Inodes staged for fast commit
1731                                          * that have data changes in them.
1732                                          */
1733         struct list_head s_fc_dentry_q[2];      /* directory entry updates */
1734         unsigned int s_fc_bytes;
1735         /*
1736          * Main fast commit lock. This lock protects accesses to the
1737          * following fields:
1738          * ei->i_fc_list, s_fc_dentry_q, s_fc_q, s_fc_bytes, s_fc_bh.
1739          */
1740         spinlock_t s_fc_lock;
1741         struct buffer_head *s_fc_bh;
1742         struct ext4_fc_stats s_fc_stats;
1743         tid_t s_fc_ineligible_tid;
1744 #ifdef CONFIG_EXT4_DEBUG
1745         int s_fc_debug_max_replay;
1746 #endif
1747         struct ext4_fc_replay_state s_fc_replay_state;
1748 };
1749
1750 static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
1751 {
1752         return sb->s_fs_info;
1753 }
1754 static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
1755 {
1756         return container_of(inode, struct ext4_inode_info, vfs_inode);
1757 }
1758
1759 static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
1760 {
1761         return ino == EXT4_ROOT_INO ||
1762                 (ino >= EXT4_FIRST_INO(sb) &&
1763                  ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
1764 }
1765
1766 /*
1767  * Returns: sbi->field[index]
1768  * Used to access an array element from the following sbi fields which require
1769  * rcu protection to avoid dereferencing an invalid pointer due to reassignment
1770  * - s_group_desc
1771  * - s_group_info
1772  * - s_flex_group
1773  */
1774 #define sbi_array_rcu_deref(sbi, field, index)                             \
1775 ({                                                                         \
1776         typeof(*((sbi)->field)) _v;                                        \
1777         rcu_read_lock();                                                   \
1778         _v = ((typeof(_v)*)rcu_dereference((sbi)->field))[index];          \
1779         rcu_read_unlock();                                                 \
1780         _v;                                                                \
1781 })
1782
1783 /*
1784  * run-time mount flags
1785  */
1786 enum {
1787         EXT4_MF_MNTDIR_SAMPLED,
1788         EXT4_MF_FS_ABORTED,     /* Fatal error detected */
1789         EXT4_MF_FC_INELIGIBLE   /* Fast commit ineligible */
1790 };
1791
1792 static inline void ext4_set_mount_flag(struct super_block *sb, int bit)
1793 {
1794         set_bit(bit, &EXT4_SB(sb)->s_mount_flags);
1795 }
1796
1797 static inline void ext4_clear_mount_flag(struct super_block *sb, int bit)
1798 {
1799         clear_bit(bit, &EXT4_SB(sb)->s_mount_flags);
1800 }
1801
1802 static inline int ext4_test_mount_flag(struct super_block *sb, int bit)
1803 {
1804         return test_bit(bit, &EXT4_SB(sb)->s_mount_flags);
1805 }
1806
1807
1808 /*
1809  * Simulate_fail codes
1810  */
1811 #define EXT4_SIM_BBITMAP_EIO    1
1812 #define EXT4_SIM_BBITMAP_CRC    2
1813 #define EXT4_SIM_IBITMAP_EIO    3
1814 #define EXT4_SIM_IBITMAP_CRC    4
1815 #define EXT4_SIM_INODE_EIO      5
1816 #define EXT4_SIM_INODE_CRC      6
1817 #define EXT4_SIM_DIRBLOCK_EIO   7
1818 #define EXT4_SIM_DIRBLOCK_CRC   8
1819
1820 static inline bool ext4_simulate_fail(struct super_block *sb,
1821                                      unsigned long code)
1822 {
1823 #ifdef CONFIG_EXT4_DEBUG
1824         struct ext4_sb_info *sbi = EXT4_SB(sb);
1825
1826         if (unlikely(sbi->s_simulate_fail == code)) {
1827                 sbi->s_simulate_fail = 0;
1828                 return true;
1829         }
1830 #endif
1831         return false;
1832 }
1833
1834 static inline void ext4_simulate_fail_bh(struct super_block *sb,
1835                                          struct buffer_head *bh,
1836                                          unsigned long code)
1837 {
1838         if (!IS_ERR(bh) && ext4_simulate_fail(sb, code))
1839                 clear_buffer_uptodate(bh);
1840 }
1841
1842 /*
1843  * Error number codes for s_{first,last}_error_errno
1844  *
1845  * Linux errno numbers are architecture specific, so we need to translate
1846  * them into something which is architecture independent.   We don't define
1847  * codes for all errno's; just the ones which are most likely to be the cause
1848  * of an ext4_error() call.
1849  */
1850 #define EXT4_ERR_UNKNOWN         1
1851 #define EXT4_ERR_EIO             2
1852 #define EXT4_ERR_ENOMEM          3
1853 #define EXT4_ERR_EFSBADCRC       4
1854 #define EXT4_ERR_EFSCORRUPTED    5
1855 #define EXT4_ERR_ENOSPC          6
1856 #define EXT4_ERR_ENOKEY          7
1857 #define EXT4_ERR_EROFS           8
1858 #define EXT4_ERR_EFBIG           9
1859 #define EXT4_ERR_EEXIST         10
1860 #define EXT4_ERR_ERANGE         11
1861 #define EXT4_ERR_EOVERFLOW      12
1862 #define EXT4_ERR_EBUSY          13
1863 #define EXT4_ERR_ENOTDIR        14
1864 #define EXT4_ERR_ENOTEMPTY      15
1865 #define EXT4_ERR_ESHUTDOWN      16
1866 #define EXT4_ERR_EFAULT         17
1867
1868 /*
1869  * Inode dynamic state flags
1870  */
1871 enum {
1872         EXT4_STATE_JDATA,               /* journaled data exists */
1873         EXT4_STATE_NEW,                 /* inode is newly created */
1874         EXT4_STATE_XATTR,               /* has in-inode xattrs */
1875         EXT4_STATE_NO_EXPAND,           /* No space for expansion */
1876         EXT4_STATE_DA_ALLOC_CLOSE,      /* Alloc DA blks on close */
1877         EXT4_STATE_EXT_MIGRATE,         /* Inode is migrating */
1878         EXT4_STATE_NEWENTRY,            /* File just added to dir */
1879         EXT4_STATE_MAY_INLINE_DATA,     /* may have in-inode data */
1880         EXT4_STATE_EXT_PRECACHED,       /* extents have been precached */
1881         EXT4_STATE_LUSTRE_EA_INODE,     /* Lustre-style ea_inode */
1882         EXT4_STATE_VERITY_IN_PROGRESS,  /* building fs-verity Merkle tree */
1883         EXT4_STATE_FC_COMMITTING,       /* Fast commit ongoing */
1884         EXT4_STATE_ORPHAN_FILE,         /* Inode orphaned in orphan file */
1885 };
1886
1887 #define EXT4_INODE_BIT_FNS(name, field, offset)                         \
1888 static inline int ext4_test_inode_##name(struct inode *inode, int bit)  \
1889 {                                                                       \
1890         return test_bit(bit + (offset), &EXT4_I(inode)->i_##field);     \
1891 }                                                                       \
1892 static inline void ext4_set_inode_##name(struct inode *inode, int bit)  \
1893 {                                                                       \
1894         set_bit(bit + (offset), &EXT4_I(inode)->i_##field);             \
1895 }                                                                       \
1896 static inline void ext4_clear_inode_##name(struct inode *inode, int bit) \
1897 {                                                                       \
1898         clear_bit(bit + (offset), &EXT4_I(inode)->i_##field);           \
1899 }
1900
1901 /* Add these declarations here only so that these functions can be
1902  * found by name.  Otherwise, they are very hard to locate. */
1903 static inline int ext4_test_inode_flag(struct inode *inode, int bit);
1904 static inline void ext4_set_inode_flag(struct inode *inode, int bit);
1905 static inline void ext4_clear_inode_flag(struct inode *inode, int bit);
1906 EXT4_INODE_BIT_FNS(flag, flags, 0)
1907
1908 /* Add these declarations here only so that these functions can be
1909  * found by name.  Otherwise, they are very hard to locate. */
1910 static inline int ext4_test_inode_state(struct inode *inode, int bit);
1911 static inline void ext4_set_inode_state(struct inode *inode, int bit);
1912 static inline void ext4_clear_inode_state(struct inode *inode, int bit);
1913 #if (BITS_PER_LONG < 64)
1914 EXT4_INODE_BIT_FNS(state, state_flags, 0)
1915
1916 static inline void ext4_clear_state_flags(struct ext4_inode_info *ei)
1917 {
1918         (ei)->i_state_flags = 0;
1919 }
1920 #else
1921 EXT4_INODE_BIT_FNS(state, flags, 32)
1922
1923 static inline void ext4_clear_state_flags(struct ext4_inode_info *ei)
1924 {
1925         /* We depend on the fact that callers will set i_flags */
1926 }
1927 #endif
1928 #else
1929 /* Assume that user mode programs are passing in an ext4fs superblock, not
1930  * a kernel struct super_block.  This will allow us to call the feature-test
1931  * macros from user land. */
1932 #define EXT4_SB(sb)     (sb)
1933 #endif
1934
1935 static inline bool ext4_verity_in_progress(struct inode *inode)
1936 {
1937         return IS_ENABLED(CONFIG_FS_VERITY) &&
1938                ext4_test_inode_state(inode, EXT4_STATE_VERITY_IN_PROGRESS);
1939 }
1940
1941 #define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
1942
1943 /*
1944  * Codes for operating systems
1945  */
1946 #define EXT4_OS_LINUX           0
1947 #define EXT4_OS_HURD            1
1948 #define EXT4_OS_MASIX           2
1949 #define EXT4_OS_FREEBSD         3
1950 #define EXT4_OS_LITES           4
1951
1952 /*
1953  * Revision levels
1954  */
1955 #define EXT4_GOOD_OLD_REV       0       /* The good old (original) format */
1956 #define EXT4_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
1957
1958 #define EXT4_MAX_SUPP_REV       EXT4_DYNAMIC_REV
1959
1960 #define EXT4_GOOD_OLD_INODE_SIZE 128
1961
1962 #define EXT4_EXTRA_TIMESTAMP_MAX        (((s64)1 << 34) - 1  + S32_MIN)
1963 #define EXT4_NON_EXTRA_TIMESTAMP_MAX    S32_MAX
1964 #define EXT4_TIMESTAMP_MIN              S32_MIN
1965
1966 /*
1967  * Feature set definitions
1968  */
1969
1970 #define EXT4_FEATURE_COMPAT_DIR_PREALLOC        0x0001
1971 #define EXT4_FEATURE_COMPAT_IMAGIC_INODES       0x0002
1972 #define EXT4_FEATURE_COMPAT_HAS_JOURNAL         0x0004
1973 #define EXT4_FEATURE_COMPAT_EXT_ATTR            0x0008
1974 #define EXT4_FEATURE_COMPAT_RESIZE_INODE        0x0010
1975 #define EXT4_FEATURE_COMPAT_DIR_INDEX           0x0020
1976 #define EXT4_FEATURE_COMPAT_SPARSE_SUPER2       0x0200
1977 /*
1978  * The reason why "FAST_COMMIT" is a compat feature is that, FS becomes
1979  * incompatible only if fast commit blocks are present in the FS. Since we
1980  * clear the journal (and thus the fast commit blocks), we don't mark FS as
1981  * incompatible. We also have a JBD2 incompat feature, which gets set when
1982  * there are fast commit blocks present in the journal.
1983  */
1984 #define EXT4_FEATURE_COMPAT_FAST_COMMIT         0x0400
1985 #define EXT4_FEATURE_COMPAT_STABLE_INODES       0x0800
1986 #define EXT4_FEATURE_COMPAT_ORPHAN_FILE         0x1000  /* Orphan file exists */
1987
1988 #define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
1989 #define EXT4_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
1990 #define EXT4_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
1991 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
1992 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM         0x0010
1993 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK        0x0020
1994 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE      0x0040
1995 #define EXT4_FEATURE_RO_COMPAT_QUOTA            0x0100
1996 #define EXT4_FEATURE_RO_COMPAT_BIGALLOC         0x0200
1997 /*
1998  * METADATA_CSUM also enables group descriptor checksums (GDT_CSUM).  When
1999  * METADATA_CSUM is set, group descriptor checksums use the same algorithm as
2000  * all other data structures' checksums.  However, the METADATA_CSUM and
2001  * GDT_CSUM bits are mutually exclusive.
2002  */
2003 #define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM    0x0400
2004 #define EXT4_FEATURE_RO_COMPAT_READONLY         0x1000
2005 #define EXT4_FEATURE_RO_COMPAT_PROJECT          0x2000
2006 #define EXT4_FEATURE_RO_COMPAT_VERITY           0x8000
2007 #define EXT4_FEATURE_RO_COMPAT_ORPHAN_PRESENT   0x10000 /* Orphan file may be
2008                                                            non-empty */
2009
2010 #define EXT4_FEATURE_INCOMPAT_COMPRESSION       0x0001
2011 #define EXT4_FEATURE_INCOMPAT_FILETYPE          0x0002
2012 #define EXT4_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
2013 #define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
2014 #define EXT4_FEATURE_INCOMPAT_META_BG           0x0010
2015 #define EXT4_FEATURE_INCOMPAT_EXTENTS           0x0040 /* extents support */
2016 #define EXT4_FEATURE_INCOMPAT_64BIT             0x0080
2017 #define EXT4_FEATURE_INCOMPAT_MMP               0x0100
2018 #define EXT4_FEATURE_INCOMPAT_FLEX_BG           0x0200
2019 #define EXT4_FEATURE_INCOMPAT_EA_INODE          0x0400 /* EA in inode */
2020 #define EXT4_FEATURE_INCOMPAT_DIRDATA           0x1000 /* data in dirent */
2021 #define EXT4_FEATURE_INCOMPAT_CSUM_SEED         0x2000
2022 #define EXT4_FEATURE_INCOMPAT_LARGEDIR          0x4000 /* >2GB or 3-lvl htree */
2023 #define EXT4_FEATURE_INCOMPAT_INLINE_DATA       0x8000 /* data in inode */
2024 #define EXT4_FEATURE_INCOMPAT_ENCRYPT           0x10000
2025 #define EXT4_FEATURE_INCOMPAT_CASEFOLD          0x20000
2026
2027 extern void ext4_update_dynamic_rev(struct super_block *sb);
2028
2029 #define EXT4_FEATURE_COMPAT_FUNCS(name, flagname) \
2030 static inline bool ext4_has_feature_##name(struct super_block *sb) \
2031 { \
2032         return ((EXT4_SB(sb)->s_es->s_feature_compat & \
2033                 cpu_to_le32(EXT4_FEATURE_COMPAT_##flagname)) != 0); \
2034 } \
2035 static inline void ext4_set_feature_##name(struct super_block *sb) \
2036 { \
2037         ext4_update_dynamic_rev(sb); \
2038         EXT4_SB(sb)->s_es->s_feature_compat |= \
2039                 cpu_to_le32(EXT4_FEATURE_COMPAT_##flagname); \
2040 } \
2041 static inline void ext4_clear_feature_##name(struct super_block *sb) \
2042 { \
2043         EXT4_SB(sb)->s_es->s_feature_compat &= \
2044                 ~cpu_to_le32(EXT4_FEATURE_COMPAT_##flagname); \
2045 }
2046
2047 #define EXT4_FEATURE_RO_COMPAT_FUNCS(name, flagname) \
2048 static inline bool ext4_has_feature_##name(struct super_block *sb) \
2049 { \
2050         return ((EXT4_SB(sb)->s_es->s_feature_ro_compat & \
2051                 cpu_to_le32(EXT4_FEATURE_RO_COMPAT_##flagname)) != 0); \
2052 } \
2053 static inline void ext4_set_feature_##name(struct super_block *sb) \
2054 { \
2055         ext4_update_dynamic_rev(sb); \
2056         EXT4_SB(sb)->s_es->s_feature_ro_compat |= \
2057                 cpu_to_le32(EXT4_FEATURE_RO_COMPAT_##flagname); \
2058 } \
2059 static inline void ext4_clear_feature_##name(struct super_block *sb) \
2060 { \
2061         EXT4_SB(sb)->s_es->s_feature_ro_compat &= \
2062                 ~cpu_to_le32(EXT4_FEATURE_RO_COMPAT_##flagname); \
2063 }
2064
2065 #define EXT4_FEATURE_INCOMPAT_FUNCS(name, flagname) \
2066 static inline bool ext4_has_feature_##name(struct super_block *sb) \
2067 { \
2068         return ((EXT4_SB(sb)->s_es->s_feature_incompat & \
2069                 cpu_to_le32(EXT4_FEATURE_INCOMPAT_##flagname)) != 0); \
2070 } \
2071 static inline void ext4_set_feature_##name(struct super_block *sb) \
2072 { \
2073         ext4_update_dynamic_rev(sb); \
2074         EXT4_SB(sb)->s_es->s_feature_incompat |= \
2075                 cpu_to_le32(EXT4_FEATURE_INCOMPAT_##flagname); \
2076 } \
2077 static inline void ext4_clear_feature_##name(struct super_block *sb) \
2078 { \
2079         EXT4_SB(sb)->s_es->s_feature_incompat &= \
2080                 ~cpu_to_le32(EXT4_FEATURE_INCOMPAT_##flagname); \
2081 }
2082
2083 EXT4_FEATURE_COMPAT_FUNCS(dir_prealloc,         DIR_PREALLOC)
2084 EXT4_FEATURE_COMPAT_FUNCS(imagic_inodes,        IMAGIC_INODES)
2085 EXT4_FEATURE_COMPAT_FUNCS(journal,              HAS_JOURNAL)
2086 EXT4_FEATURE_COMPAT_FUNCS(xattr,                EXT_ATTR)
2087 EXT4_FEATURE_COMPAT_FUNCS(resize_inode,         RESIZE_INODE)
2088 EXT4_FEATURE_COMPAT_FUNCS(dir_index,            DIR_INDEX)
2089 EXT4_FEATURE_COMPAT_FUNCS(sparse_super2,        SPARSE_SUPER2)
2090 EXT4_FEATURE_COMPAT_FUNCS(fast_commit,          FAST_COMMIT)
2091 EXT4_FEATURE_COMPAT_FUNCS(stable_inodes,        STABLE_INODES)
2092 EXT4_FEATURE_COMPAT_FUNCS(orphan_file,          ORPHAN_FILE)
2093
2094 EXT4_FEATURE_RO_COMPAT_FUNCS(sparse_super,      SPARSE_SUPER)
2095 EXT4_FEATURE_RO_COMPAT_FUNCS(large_file,        LARGE_FILE)
2096 EXT4_FEATURE_RO_COMPAT_FUNCS(btree_dir,         BTREE_DIR)
2097 EXT4_FEATURE_RO_COMPAT_FUNCS(huge_file,         HUGE_FILE)
2098 EXT4_FEATURE_RO_COMPAT_FUNCS(gdt_csum,          GDT_CSUM)
2099 EXT4_FEATURE_RO_COMPAT_FUNCS(dir_nlink,         DIR_NLINK)
2100 EXT4_FEATURE_RO_COMPAT_FUNCS(extra_isize,       EXTRA_ISIZE)
2101 EXT4_FEATURE_RO_COMPAT_FUNCS(quota,             QUOTA)
2102 EXT4_FEATURE_RO_COMPAT_FUNCS(bigalloc,          BIGALLOC)
2103 EXT4_FEATURE_RO_COMPAT_FUNCS(metadata_csum,     METADATA_CSUM)
2104 EXT4_FEATURE_RO_COMPAT_FUNCS(readonly,          READONLY)
2105 EXT4_FEATURE_RO_COMPAT_FUNCS(project,           PROJECT)
2106 EXT4_FEATURE_RO_COMPAT_FUNCS(verity,            VERITY)
2107 EXT4_FEATURE_RO_COMPAT_FUNCS(orphan_present,    ORPHAN_PRESENT)
2108
2109 EXT4_FEATURE_INCOMPAT_FUNCS(compression,        COMPRESSION)
2110 EXT4_FEATURE_INCOMPAT_FUNCS(filetype,           FILETYPE)
2111 EXT4_FEATURE_INCOMPAT_FUNCS(journal_needs_recovery,     RECOVER)
2112 EXT4_FEATURE_INCOMPAT_FUNCS(journal_dev,        JOURNAL_DEV)
2113 EXT4_FEATURE_INCOMPAT_FUNCS(meta_bg,            META_BG)
2114 EXT4_FEATURE_INCOMPAT_FUNCS(extents,            EXTENTS)
2115 EXT4_FEATURE_INCOMPAT_FUNCS(64bit,              64BIT)
2116 EXT4_FEATURE_INCOMPAT_FUNCS(mmp,                MMP)
2117 EXT4_FEATURE_INCOMPAT_FUNCS(flex_bg,            FLEX_BG)
2118 EXT4_FEATURE_INCOMPAT_FUNCS(ea_inode,           EA_INODE)
2119 EXT4_FEATURE_INCOMPAT_FUNCS(dirdata,            DIRDATA)
2120 EXT4_FEATURE_INCOMPAT_FUNCS(csum_seed,          CSUM_SEED)
2121 EXT4_FEATURE_INCOMPAT_FUNCS(largedir,           LARGEDIR)
2122 EXT4_FEATURE_INCOMPAT_FUNCS(inline_data,        INLINE_DATA)
2123 EXT4_FEATURE_INCOMPAT_FUNCS(encrypt,            ENCRYPT)
2124 EXT4_FEATURE_INCOMPAT_FUNCS(casefold,           CASEFOLD)
2125
2126 #define EXT2_FEATURE_COMPAT_SUPP        EXT4_FEATURE_COMPAT_EXT_ATTR
2127 #define EXT2_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
2128                                          EXT4_FEATURE_INCOMPAT_META_BG)
2129 #define EXT2_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
2130                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
2131                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
2132
2133 #define EXT3_FEATURE_COMPAT_SUPP        EXT4_FEATURE_COMPAT_EXT_ATTR
2134 #define EXT3_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
2135                                          EXT4_FEATURE_INCOMPAT_RECOVER| \
2136                                          EXT4_FEATURE_INCOMPAT_META_BG)
2137 #define EXT3_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
2138                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
2139                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
2140
2141 #define EXT4_FEATURE_COMPAT_SUPP        (EXT4_FEATURE_COMPAT_EXT_ATTR| \
2142                                          EXT4_FEATURE_COMPAT_ORPHAN_FILE)
2143 #define EXT4_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
2144                                          EXT4_FEATURE_INCOMPAT_RECOVER| \
2145                                          EXT4_FEATURE_INCOMPAT_META_BG| \
2146                                          EXT4_FEATURE_INCOMPAT_EXTENTS| \
2147                                          EXT4_FEATURE_INCOMPAT_64BIT| \
2148                                          EXT4_FEATURE_INCOMPAT_FLEX_BG| \
2149                                          EXT4_FEATURE_INCOMPAT_EA_INODE| \
2150                                          EXT4_FEATURE_INCOMPAT_MMP | \
2151                                          EXT4_FEATURE_INCOMPAT_INLINE_DATA | \
2152                                          EXT4_FEATURE_INCOMPAT_ENCRYPT | \
2153                                          EXT4_FEATURE_INCOMPAT_CASEFOLD | \
2154                                          EXT4_FEATURE_INCOMPAT_CSUM_SEED | \
2155                                          EXT4_FEATURE_INCOMPAT_LARGEDIR)
2156 #define EXT4_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
2157                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
2158                                          EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
2159                                          EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
2160                                          EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
2161                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
2162                                          EXT4_FEATURE_RO_COMPAT_HUGE_FILE |\
2163                                          EXT4_FEATURE_RO_COMPAT_BIGALLOC |\
2164                                          EXT4_FEATURE_RO_COMPAT_METADATA_CSUM|\
2165                                          EXT4_FEATURE_RO_COMPAT_QUOTA |\
2166                                          EXT4_FEATURE_RO_COMPAT_PROJECT |\
2167                                          EXT4_FEATURE_RO_COMPAT_VERITY |\
2168                                          EXT4_FEATURE_RO_COMPAT_ORPHAN_PRESENT)
2169
2170 #define EXTN_FEATURE_FUNCS(ver) \
2171 static inline bool ext4_has_unknown_ext##ver##_compat_features(struct super_block *sb) \
2172 { \
2173         return ((EXT4_SB(sb)->s_es->s_feature_compat & \
2174                 cpu_to_le32(~EXT##ver##_FEATURE_COMPAT_SUPP)) != 0); \
2175 } \
2176 static inline bool ext4_has_unknown_ext##ver##_ro_compat_features(struct super_block *sb) \
2177 { \
2178         return ((EXT4_SB(sb)->s_es->s_feature_ro_compat & \
2179                 cpu_to_le32(~EXT##ver##_FEATURE_RO_COMPAT_SUPP)) != 0); \
2180 } \
2181 static inline bool ext4_has_unknown_ext##ver##_incompat_features(struct super_block *sb) \
2182 { \
2183         return ((EXT4_SB(sb)->s_es->s_feature_incompat & \
2184                 cpu_to_le32(~EXT##ver##_FEATURE_INCOMPAT_SUPP)) != 0); \
2185 }
2186
2187 EXTN_FEATURE_FUNCS(2)
2188 EXTN_FEATURE_FUNCS(3)
2189 EXTN_FEATURE_FUNCS(4)
2190
2191 static inline bool ext4_has_compat_features(struct super_block *sb)
2192 {
2193         return (EXT4_SB(sb)->s_es->s_feature_compat != 0);
2194 }
2195 static inline bool ext4_has_ro_compat_features(struct super_block *sb)
2196 {
2197         return (EXT4_SB(sb)->s_es->s_feature_ro_compat != 0);
2198 }
2199 static inline bool ext4_has_incompat_features(struct super_block *sb)
2200 {
2201         return (EXT4_SB(sb)->s_es->s_feature_incompat != 0);
2202 }
2203
2204 extern int ext4_feature_set_ok(struct super_block *sb, int readonly);
2205
2206 /*
2207  * Superblock flags
2208  */
2209 #define EXT4_FLAGS_RESIZING     0
2210 #define EXT4_FLAGS_SHUTDOWN     1
2211 #define EXT4_FLAGS_BDEV_IS_DAX  2
2212
2213 static inline int ext4_forced_shutdown(struct ext4_sb_info *sbi)
2214 {
2215         return test_bit(EXT4_FLAGS_SHUTDOWN, &sbi->s_ext4_flags);
2216 }
2217
2218 /*
2219  * Default values for user and/or group using reserved blocks
2220  */
2221 #define EXT4_DEF_RESUID         0
2222 #define EXT4_DEF_RESGID         0
2223
2224 /*
2225  * Default project ID
2226  */
2227 #define EXT4_DEF_PROJID         0
2228
2229 #define EXT4_DEF_INODE_READAHEAD_BLKS   32
2230
2231 /*
2232  * Default mount options
2233  */
2234 #define EXT4_DEFM_DEBUG         0x0001
2235 #define EXT4_DEFM_BSDGROUPS     0x0002
2236 #define EXT4_DEFM_XATTR_USER    0x0004
2237 #define EXT4_DEFM_ACL           0x0008
2238 #define EXT4_DEFM_UID16         0x0010
2239 #define EXT4_DEFM_JMODE         0x0060
2240 #define EXT4_DEFM_JMODE_DATA    0x0020
2241 #define EXT4_DEFM_JMODE_ORDERED 0x0040
2242 #define EXT4_DEFM_JMODE_WBACK   0x0060
2243 #define EXT4_DEFM_NOBARRIER     0x0100
2244 #define EXT4_DEFM_BLOCK_VALIDITY 0x0200
2245 #define EXT4_DEFM_DISCARD       0x0400
2246 #define EXT4_DEFM_NODELALLOC    0x0800
2247
2248 /*
2249  * Default journal batch times
2250  */
2251 #define EXT4_DEF_MIN_BATCH_TIME 0
2252 #define EXT4_DEF_MAX_BATCH_TIME 15000 /* 15ms */
2253
2254 /*
2255  * Minimum number of groups in a flexgroup before we separate out
2256  * directories into the first block group of a flexgroup
2257  */
2258 #define EXT4_FLEX_SIZE_DIR_ALLOC_SCHEME 4
2259
2260 /*
2261  * Structure of a directory entry
2262  */
2263 #define EXT4_NAME_LEN 255
2264 /*
2265  * Base length of the ext4 directory entry excluding the name length
2266  */
2267 #define EXT4_BASE_DIR_LEN (sizeof(struct ext4_dir_entry_2) - EXT4_NAME_LEN)
2268
2269 struct ext4_dir_entry {
2270         __le32  inode;                  /* Inode number */
2271         __le16  rec_len;                /* Directory entry length */
2272         __le16  name_len;               /* Name length */
2273         char    name[EXT4_NAME_LEN];    /* File name */
2274 };
2275
2276
2277 /*
2278  * Encrypted Casefolded entries require saving the hash on disk. This structure
2279  * followed ext4_dir_entry_2's name[name_len] at the next 4 byte aligned
2280  * boundary.
2281  */
2282 struct ext4_dir_entry_hash {
2283         __le32 hash;
2284         __le32 minor_hash;
2285 };
2286
2287 /*
2288  * The new version of the directory entry.  Since EXT4 structures are
2289  * stored in intel byte order, and the name_len field could never be
2290  * bigger than 255 chars, it's safe to reclaim the extra byte for the
2291  * file_type field.
2292  */
2293 struct ext4_dir_entry_2 {
2294         __le32  inode;                  /* Inode number */
2295         __le16  rec_len;                /* Directory entry length */
2296         __u8    name_len;               /* Name length */
2297         __u8    file_type;              /* See file type macros EXT4_FT_* below */
2298         char    name[EXT4_NAME_LEN];    /* File name */
2299 };
2300
2301 /*
2302  * Access the hashes at the end of ext4_dir_entry_2
2303  */
2304 #define EXT4_DIRENT_HASHES(entry) \
2305         ((struct ext4_dir_entry_hash *) \
2306                 (((void *)(entry)) + \
2307                 ((8 + (entry)->name_len + EXT4_DIR_ROUND) & ~EXT4_DIR_ROUND)))
2308 #define EXT4_DIRENT_HASH(entry) le32_to_cpu(EXT4_DIRENT_HASHES(de)->hash)
2309 #define EXT4_DIRENT_MINOR_HASH(entry) \
2310                 le32_to_cpu(EXT4_DIRENT_HASHES(de)->minor_hash)
2311
2312 static inline bool ext4_hash_in_dirent(const struct inode *inode)
2313 {
2314         return IS_CASEFOLDED(inode) && IS_ENCRYPTED(inode);
2315 }
2316
2317 /*
2318  * This is a bogus directory entry at the end of each leaf block that
2319  * records checksums.
2320  */
2321 struct ext4_dir_entry_tail {
2322         __le32  det_reserved_zero1;     /* Pretend to be unused */
2323         __le16  det_rec_len;            /* 12 */
2324         __u8    det_reserved_zero2;     /* Zero name length */
2325         __u8    det_reserved_ft;        /* 0xDE, fake file type */
2326         __le32  det_checksum;           /* crc32c(uuid+inum+dirblock) */
2327 };
2328
2329 #define EXT4_DIRENT_TAIL(block, blocksize) \
2330         ((struct ext4_dir_entry_tail *)(((void *)(block)) + \
2331                                         ((blocksize) - \
2332                                          sizeof(struct ext4_dir_entry_tail))))
2333
2334 /*
2335  * Ext4 directory file types.  Only the low 3 bits are used.  The
2336  * other bits are reserved for now.
2337  */
2338 #define EXT4_FT_UNKNOWN         0
2339 #define EXT4_FT_REG_FILE        1
2340 #define EXT4_FT_DIR             2
2341 #define EXT4_FT_CHRDEV          3
2342 #define EXT4_FT_BLKDEV          4
2343 #define EXT4_FT_FIFO            5
2344 #define EXT4_FT_SOCK            6
2345 #define EXT4_FT_SYMLINK         7
2346
2347 #define EXT4_FT_MAX             8
2348
2349 #define EXT4_FT_DIR_CSUM        0xDE
2350
2351 /*
2352  * EXT4_DIR_PAD defines the directory entries boundaries
2353  *
2354  * NOTE: It must be a multiple of 4
2355  */
2356 #define EXT4_DIR_PAD                    4
2357 #define EXT4_DIR_ROUND                  (EXT4_DIR_PAD - 1)
2358 #define EXT4_MAX_REC_LEN                ((1<<16)-1)
2359
2360 /*
2361  * The rec_len is dependent on the type of directory. Directories that are
2362  * casefolded and encrypted need to store the hash as well, so we add room for
2363  * ext4_extended_dir_entry_2. For all entries related to '.' or '..' you should
2364  * pass NULL for dir, as those entries do not use the extra fields.
2365  */
2366 static inline unsigned int ext4_dir_rec_len(__u8 name_len,
2367                                                 const struct inode *dir)
2368 {
2369         int rec_len = (name_len + 8 + EXT4_DIR_ROUND);
2370
2371         if (dir && ext4_hash_in_dirent(dir))
2372                 rec_len += sizeof(struct ext4_dir_entry_hash);
2373         return (rec_len & ~EXT4_DIR_ROUND);
2374 }
2375
2376 /*
2377  * If we ever get support for fs block sizes > page_size, we'll need
2378  * to remove the #if statements in the next two functions...
2379  */
2380 static inline unsigned int
2381 ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize)
2382 {
2383         unsigned len = le16_to_cpu(dlen);
2384
2385 #if (PAGE_SIZE >= 65536)
2386         if (len == EXT4_MAX_REC_LEN || len == 0)
2387                 return blocksize;
2388         return (len & 65532) | ((len & 3) << 16);
2389 #else
2390         return len;
2391 #endif
2392 }
2393
2394 static inline __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize)
2395 {
2396         if ((len > blocksize) || (blocksize > (1 << 18)) || (len & 3))
2397                 BUG();
2398 #if (PAGE_SIZE >= 65536)
2399         if (len < 65536)
2400                 return cpu_to_le16(len);
2401         if (len == blocksize) {
2402                 if (blocksize == 65536)
2403                         return cpu_to_le16(EXT4_MAX_REC_LEN);
2404                 else
2405                         return cpu_to_le16(0);
2406         }
2407         return cpu_to_le16((len & 65532) | ((len >> 16) & 3));
2408 #else
2409         return cpu_to_le16(len);
2410 #endif
2411 }
2412
2413 /*
2414  * Hash Tree Directory indexing
2415  * (c) Daniel Phillips, 2001
2416  */
2417
2418 #define is_dx(dir) (ext4_has_feature_dir_index((dir)->i_sb) && \
2419                     ext4_test_inode_flag((dir), EXT4_INODE_INDEX))
2420 #define EXT4_DIR_LINK_MAX(dir) unlikely((dir)->i_nlink >= EXT4_LINK_MAX && \
2421                     !(ext4_has_feature_dir_nlink((dir)->i_sb) && is_dx(dir)))
2422 #define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
2423
2424 /* Legal values for the dx_root hash_version field: */
2425
2426 #define DX_HASH_LEGACY                  0
2427 #define DX_HASH_HALF_MD4                1
2428 #define DX_HASH_TEA                     2
2429 #define DX_HASH_LEGACY_UNSIGNED         3
2430 #define DX_HASH_HALF_MD4_UNSIGNED       4
2431 #define DX_HASH_TEA_UNSIGNED            5
2432 #define DX_HASH_SIPHASH                 6
2433
2434 static inline u32 ext4_chksum(struct ext4_sb_info *sbi, u32 crc,
2435                               const void *address, unsigned int length)
2436 {
2437         struct {
2438                 struct shash_desc shash;
2439                 char ctx[4];
2440         } desc;
2441
2442         BUG_ON(crypto_shash_descsize(sbi->s_chksum_driver)!=sizeof(desc.ctx));
2443
2444         desc.shash.tfm = sbi->s_chksum_driver;
2445         *(u32 *)desc.ctx = crc;
2446
2447         BUG_ON(crypto_shash_update(&desc.shash, address, length));
2448
2449         return *(u32 *)desc.ctx;
2450 }
2451
2452 #ifdef __KERNEL__
2453
2454 /* hash info structure used by the directory hash */
2455 struct dx_hash_info
2456 {
2457         u32             hash;
2458         u32             minor_hash;
2459         int             hash_version;
2460         u32             *seed;
2461 };
2462
2463
2464 /* 32 and 64 bit signed EOF for dx directories */
2465 #define EXT4_HTREE_EOF_32BIT   ((1UL  << (32 - 1)) - 1)
2466 #define EXT4_HTREE_EOF_64BIT   ((1ULL << (64 - 1)) - 1)
2467
2468
2469 /*
2470  * Control parameters used by ext4_htree_next_block
2471  */
2472 #define HASH_NB_ALWAYS          1
2473
2474 struct ext4_filename {
2475         const struct qstr *usr_fname;
2476         struct fscrypt_str disk_name;
2477         struct dx_hash_info hinfo;
2478 #ifdef CONFIG_FS_ENCRYPTION
2479         struct fscrypt_str crypto_buf;
2480 #endif
2481 #ifdef CONFIG_UNICODE
2482         struct fscrypt_str cf_name;
2483 #endif
2484 };
2485
2486 #define fname_name(p) ((p)->disk_name.name)
2487 #define fname_usr_name(p) ((p)->usr_fname->name)
2488 #define fname_len(p)  ((p)->disk_name.len)
2489
2490 /*
2491  * Describe an inode's exact location on disk and in memory
2492  */
2493 struct ext4_iloc
2494 {
2495         struct buffer_head *bh;
2496         unsigned long offset;
2497         ext4_group_t block_group;
2498 };
2499
2500 static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
2501 {
2502         return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
2503 }
2504
2505 static inline bool ext4_is_quota_file(struct inode *inode)
2506 {
2507         return IS_NOQUOTA(inode) &&
2508                !(EXT4_I(inode)->i_flags & EXT4_EA_INODE_FL);
2509 }
2510
2511 /*
2512  * This structure is stuffed into the struct file's private_data field
2513  * for directories.  It is where we put information so that we can do
2514  * readdir operations in hash tree order.
2515  */
2516 struct dir_private_info {
2517         struct rb_root  root;
2518         struct rb_node  *curr_node;
2519         struct fname    *extra_fname;
2520         loff_t          last_pos;
2521         __u32           curr_hash;
2522         __u32           curr_minor_hash;
2523         __u32           next_hash;
2524 };
2525
2526 /* calculate the first block number of the group */
2527 static inline ext4_fsblk_t
2528 ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
2529 {
2530         return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
2531                 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
2532 }
2533
2534 /*
2535  * Special error return code only used by dx_probe() and its callers.
2536  */
2537 #define ERR_BAD_DX_DIR  (-(MAX_ERRNO - 1))
2538
2539 /* htree levels for ext4 */
2540 #define EXT4_HTREE_LEVEL_COMPAT 2
2541 #define EXT4_HTREE_LEVEL        3
2542
2543 static inline int ext4_dir_htree_level(struct super_block *sb)
2544 {
2545         return ext4_has_feature_largedir(sb) ?
2546                 EXT4_HTREE_LEVEL : EXT4_HTREE_LEVEL_COMPAT;
2547 }
2548
2549 /*
2550  * Timeout and state flag for lazy initialization inode thread.
2551  */
2552 #define EXT4_DEF_LI_WAIT_MULT                   10
2553 #define EXT4_DEF_LI_MAX_START_DELAY             5
2554 #define EXT4_LAZYINIT_QUIT                      0x0001
2555 #define EXT4_LAZYINIT_RUNNING                   0x0002
2556
2557 /*
2558  * Lazy inode table initialization info
2559  */
2560 struct ext4_lazy_init {
2561         unsigned long           li_state;
2562         struct list_head        li_request_list;
2563         struct mutex            li_list_mtx;
2564 };
2565
2566 enum ext4_li_mode {
2567         EXT4_LI_MODE_PREFETCH_BBITMAP,
2568         EXT4_LI_MODE_ITABLE,
2569 };
2570
2571 struct ext4_li_request {
2572         struct super_block      *lr_super;
2573         enum ext4_li_mode       lr_mode;
2574         ext4_group_t            lr_first_not_zeroed;
2575         ext4_group_t            lr_next_group;
2576         struct list_head        lr_request;
2577         unsigned long           lr_next_sched;
2578         unsigned long           lr_timeout;
2579 };
2580
2581 struct ext4_features {
2582         struct kobject f_kobj;
2583         struct completion f_kobj_unregister;
2584 };
2585
2586 /*
2587  * This structure will be used for multiple mount protection. It will be
2588  * written into the block number saved in the s_mmp_block field in the
2589  * superblock. Programs that check MMP should assume that if
2590  * SEQ_FSCK (or any unknown code above SEQ_MAX) is present then it is NOT safe
2591  * to use the filesystem, regardless of how old the timestamp is.
2592  */
2593 #define EXT4_MMP_MAGIC     0x004D4D50U /* ASCII for MMP */
2594 #define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
2595 #define EXT4_MMP_SEQ_FSCK  0xE24D4D50U /* mmp_seq value when being fscked */
2596 #define EXT4_MMP_SEQ_MAX   0xE24D4D4FU /* maximum valid mmp_seq value */
2597
2598 struct mmp_struct {
2599         __le32  mmp_magic;              /* Magic number for MMP */
2600         __le32  mmp_seq;                /* Sequence no. updated periodically */
2601
2602         /*
2603          * mmp_time, mmp_nodename & mmp_bdevname are only used for information
2604          * purposes and do not affect the correctness of the algorithm
2605          */
2606         __le64  mmp_time;               /* Time last updated */
2607         char    mmp_nodename[64];       /* Node which last updated MMP block */
2608         char    mmp_bdevname[32];       /* Bdev which last updated MMP block */
2609
2610         /*
2611          * mmp_check_interval is used to verify if the MMP block has been
2612          * updated on the block device. The value is updated based on the
2613          * maximum time to write the MMP block during an update cycle.
2614          */
2615         __le16  mmp_check_interval;
2616
2617         __le16  mmp_pad1;
2618         __le32  mmp_pad2[226];
2619         __le32  mmp_checksum;           /* crc32c(uuid+mmp_block) */
2620 };
2621
2622 /* arguments passed to the mmp thread */
2623 struct mmpd_data {
2624         struct buffer_head *bh; /* bh from initial read_mmp_block() */
2625         struct super_block *sb;  /* super block of the fs */
2626 };
2627
2628 /*
2629  * Check interval multiplier
2630  * The MMP block is written every update interval and initially checked every
2631  * update interval x the multiplier (the value is then adapted based on the
2632  * write latency). The reason is that writes can be delayed under load and we
2633  * don't want readers to incorrectly assume that the filesystem is no longer
2634  * in use.
2635  */
2636 #define EXT4_MMP_CHECK_MULT             2UL
2637
2638 /*
2639  * Minimum interval for MMP checking in seconds.
2640  */
2641 #define EXT4_MMP_MIN_CHECK_INTERVAL     5UL
2642
2643 /*
2644  * Maximum interval for MMP checking in seconds.
2645  */
2646 #define EXT4_MMP_MAX_CHECK_INTERVAL     300UL
2647
2648 /*
2649  * Function prototypes
2650  */
2651
2652 /*
2653  * Ok, these declarations are also in <linux/kernel.h> but none of the
2654  * ext4 source programs needs to include it so they are duplicated here.
2655  */
2656 # define NORET_TYPE     /**/
2657 # define ATTRIB_NORET   __attribute__((noreturn))
2658 # define NORET_AND      noreturn,
2659
2660 /* bitmap.c */
2661 extern unsigned int ext4_count_free(char *bitmap, unsigned numchars);
2662 void ext4_inode_bitmap_csum_set(struct super_block *sb, ext4_group_t group,
2663                                 struct ext4_group_desc *gdp,
2664                                 struct buffer_head *bh, int sz);
2665 int ext4_inode_bitmap_csum_verify(struct super_block *sb, ext4_group_t group,
2666                                   struct ext4_group_desc *gdp,
2667                                   struct buffer_head *bh, int sz);
2668 void ext4_block_bitmap_csum_set(struct super_block *sb, ext4_group_t group,
2669                                 struct ext4_group_desc *gdp,
2670                                 struct buffer_head *bh);
2671 int ext4_block_bitmap_csum_verify(struct super_block *sb, ext4_group_t group,
2672                                   struct ext4_group_desc *gdp,
2673                                   struct buffer_head *bh);
2674
2675 /* balloc.c */
2676 extern void ext4_get_group_no_and_offset(struct super_block *sb,
2677                                          ext4_fsblk_t blocknr,
2678                                          ext4_group_t *blockgrpp,
2679                                          ext4_grpblk_t *offsetp);
2680 extern ext4_group_t ext4_get_group_number(struct super_block *sb,
2681                                           ext4_fsblk_t block);
2682
2683 extern unsigned int ext4_block_group(struct super_block *sb,
2684                         ext4_fsblk_t blocknr);
2685 extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
2686                         ext4_fsblk_t blocknr);
2687 extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
2688 extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
2689                         ext4_group_t group);
2690 extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
2691                                          ext4_fsblk_t goal,
2692                                          unsigned int flags,
2693                                          unsigned long *count,
2694                                          int *errp);
2695 extern int ext4_claim_free_clusters(struct ext4_sb_info *sbi,
2696                                     s64 nclusters, unsigned int flags);
2697 extern ext4_fsblk_t ext4_count_free_clusters(struct super_block *);
2698 extern void ext4_check_blocks_bitmap(struct super_block *);
2699 extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
2700                                                     ext4_group_t block_group,
2701                                                     struct buffer_head ** bh);
2702 extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
2703
2704 extern struct buffer_head *ext4_read_block_bitmap_nowait(struct super_block *sb,
2705                                                 ext4_group_t block_group,
2706                                                 bool ignore_locked);
2707 extern int ext4_wait_block_bitmap(struct super_block *sb,
2708                                   ext4_group_t block_group,
2709                                   struct buffer_head *bh);
2710 extern struct buffer_head *ext4_read_block_bitmap(struct super_block *sb,
2711                                                   ext4_group_t block_group);
2712 extern unsigned ext4_free_clusters_after_init(struct super_block *sb,
2713                                               ext4_group_t block_group,
2714                                               struct ext4_group_desc *gdp);
2715 ext4_fsblk_t ext4_inode_to_goal_block(struct inode *);
2716
2717 #ifdef CONFIG_UNICODE
2718 extern int ext4_fname_setup_ci_filename(struct inode *dir,
2719                                          const struct qstr *iname,
2720                                          struct ext4_filename *fname);
2721 #endif
2722
2723 #ifdef CONFIG_FS_ENCRYPTION
2724 static inline void ext4_fname_from_fscrypt_name(struct ext4_filename *dst,
2725                                                 const struct fscrypt_name *src)
2726 {
2727         memset(dst, 0, sizeof(*dst));
2728
2729         dst->usr_fname = src->usr_fname;
2730         dst->disk_name = src->disk_name;
2731         dst->hinfo.hash = src->hash;
2732         dst->hinfo.minor_hash = src->minor_hash;
2733         dst->crypto_buf = src->crypto_buf;
2734 }
2735
2736 static inline int ext4_fname_setup_filename(struct inode *dir,
2737                                             const struct qstr *iname,
2738                                             int lookup,
2739                                             struct ext4_filename *fname)
2740 {
2741         struct fscrypt_name name;
2742         int err;
2743
2744         err = fscrypt_setup_filename(dir, iname, lookup, &name);
2745         if (err)
2746                 return err;
2747
2748         ext4_fname_from_fscrypt_name(fname, &name);
2749
2750 #ifdef CONFIG_UNICODE
2751         err = ext4_fname_setup_ci_filename(dir, iname, fname);
2752 #endif
2753         return err;
2754 }
2755
2756 static inline int ext4_fname_prepare_lookup(struct inode *dir,
2757                                             struct dentry *dentry,
2758                                             struct ext4_filename *fname)
2759 {
2760         struct fscrypt_name name;
2761         int err;
2762
2763         err = fscrypt_prepare_lookup(dir, dentry, &name);
2764         if (err)
2765                 return err;
2766
2767         ext4_fname_from_fscrypt_name(fname, &name);
2768
2769 #ifdef CONFIG_UNICODE
2770         err = ext4_fname_setup_ci_filename(dir, &dentry->d_name, fname);
2771 #endif
2772         return err;
2773 }
2774
2775 static inline void ext4_fname_free_filename(struct ext4_filename *fname)
2776 {
2777         struct fscrypt_name name;
2778
2779         name.crypto_buf = fname->crypto_buf;
2780         fscrypt_free_filename(&name);
2781
2782         fname->crypto_buf.name = NULL;
2783         fname->usr_fname = NULL;
2784         fname->disk_name.name = NULL;
2785
2786 #ifdef CONFIG_UNICODE
2787         kfree(fname->cf_name.name);
2788         fname->cf_name.name = NULL;
2789 #endif
2790 }
2791 #else /* !CONFIG_FS_ENCRYPTION */
2792 static inline int ext4_fname_setup_filename(struct inode *dir,
2793                                             const struct qstr *iname,
2794                                             int lookup,
2795                                             struct ext4_filename *fname)
2796 {
2797         int err = 0;
2798         fname->usr_fname = iname;
2799         fname->disk_name.name = (unsigned char *) iname->name;
2800         fname->disk_name.len = iname->len;
2801
2802 #ifdef CONFIG_UNICODE
2803         err = ext4_fname_setup_ci_filename(dir, iname, fname);
2804 #endif
2805
2806         return err;
2807 }
2808
2809 static inline int ext4_fname_prepare_lookup(struct inode *dir,
2810                                             struct dentry *dentry,
2811                                             struct ext4_filename *fname)
2812 {
2813         return ext4_fname_setup_filename(dir, &dentry->d_name, 1, fname);
2814 }
2815
2816 static inline void ext4_fname_free_filename(struct ext4_filename *fname)
2817 {
2818 #ifdef CONFIG_UNICODE
2819         kfree(fname->cf_name.name);
2820         fname->cf_name.name = NULL;
2821 #endif
2822 }
2823 #endif /* !CONFIG_FS_ENCRYPTION */
2824
2825 /* dir.c */
2826 extern int __ext4_check_dir_entry(const char *, unsigned int, struct inode *,
2827                                   struct file *,
2828                                   struct ext4_dir_entry_2 *,
2829                                   struct buffer_head *, char *, int,
2830                                   unsigned int);
2831 #define ext4_check_dir_entry(dir, filp, de, bh, buf, size, offset) \
2832         unlikely(__ext4_check_dir_entry(__func__, __LINE__, (dir), (filp), \
2833                                 (de), (bh), (buf), (size), (offset)))
2834 extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
2835                                 __u32 minor_hash,
2836                                 struct ext4_dir_entry_2 *dirent,
2837                                 struct fscrypt_str *ent_name);
2838 extern void ext4_htree_free_dir_info(struct dir_private_info *p);
2839 extern int ext4_find_dest_de(struct inode *dir, struct inode *inode,
2840                              struct buffer_head *bh,
2841                              void *buf, int buf_size,
2842                              struct ext4_filename *fname,
2843                              struct ext4_dir_entry_2 **dest_de);
2844 void ext4_insert_dentry(struct inode *dir, struct inode *inode,
2845                         struct ext4_dir_entry_2 *de,
2846                         int buf_size,
2847                         struct ext4_filename *fname);
2848 static inline void ext4_update_dx_flag(struct inode *inode)
2849 {
2850         if (!ext4_has_feature_dir_index(inode->i_sb) &&
2851             ext4_test_inode_flag(inode, EXT4_INODE_INDEX)) {
2852                 /* ext4_iget() should have caught this... */
2853                 WARN_ON_ONCE(ext4_has_feature_metadata_csum(inode->i_sb));
2854                 ext4_clear_inode_flag(inode, EXT4_INODE_INDEX);
2855         }
2856 }
2857 static const unsigned char ext4_filetype_table[] = {
2858         DT_UNKNOWN, DT_REG, DT_DIR, DT_CHR, DT_BLK, DT_FIFO, DT_SOCK, DT_LNK
2859 };
2860
2861 static inline  unsigned char get_dtype(struct super_block *sb, int filetype)
2862 {
2863         if (!ext4_has_feature_filetype(sb) || filetype >= EXT4_FT_MAX)
2864                 return DT_UNKNOWN;
2865
2866         return ext4_filetype_table[filetype];
2867 }
2868 extern int ext4_check_all_de(struct inode *dir, struct buffer_head *bh,
2869                              void *buf, int buf_size);
2870
2871 /* fsync.c */
2872 extern int ext4_sync_file(struct file *, loff_t, loff_t, int);
2873
2874 /* hash.c */
2875 extern int ext4fs_dirhash(const struct inode *dir, const char *name, int len,
2876                           struct dx_hash_info *hinfo);
2877
2878 /* ialloc.c */
2879 extern int ext4_mark_inode_used(struct super_block *sb, int ino);
2880 extern struct inode *__ext4_new_inode(struct user_namespace *, handle_t *,
2881                                       struct inode *, umode_t,
2882                                       const struct qstr *qstr, __u32 goal,
2883                                       uid_t *owner, __u32 i_flags,
2884                                       int handle_type, unsigned int line_no,
2885                                       int nblocks);
2886
2887 #define ext4_new_inode(handle, dir, mode, qstr, goal, owner, i_flags)          \
2888         __ext4_new_inode(&init_user_ns, (handle), (dir), (mode), (qstr),       \
2889                          (goal), (owner), i_flags, 0, 0, 0)
2890 #define ext4_new_inode_start_handle(mnt_userns, dir, mode, qstr, goal, owner, \
2891                                     type, nblocks)                  \
2892         __ext4_new_inode((mnt_userns), NULL, (dir), (mode), (qstr), (goal), (owner), \
2893                          0, (type), __LINE__, (nblocks))
2894
2895
2896 extern void ext4_free_inode(handle_t *, struct inode *);
2897 extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
2898 extern unsigned long ext4_count_free_inodes(struct super_block *);
2899 extern unsigned long ext4_count_dirs(struct super_block *);
2900 extern void ext4_check_inodes_bitmap(struct super_block *);
2901 extern void ext4_mark_bitmap_end(int start_bit, int end_bit, char *bitmap);
2902 extern int ext4_init_inode_table(struct super_block *sb,
2903                                  ext4_group_t group, int barrier);
2904 extern void ext4_end_bitmap_read(struct buffer_head *bh, int uptodate);
2905
2906 /* fast_commit.c */
2907 int ext4_fc_info_show(struct seq_file *seq, void *v);
2908 void ext4_fc_init(struct super_block *sb, journal_t *journal);
2909 void ext4_fc_init_inode(struct inode *inode);
2910 void ext4_fc_track_range(handle_t *handle, struct inode *inode, ext4_lblk_t start,
2911                          ext4_lblk_t end);
2912 void __ext4_fc_track_unlink(handle_t *handle, struct inode *inode,
2913         struct dentry *dentry);
2914 void __ext4_fc_track_link(handle_t *handle, struct inode *inode,
2915         struct dentry *dentry);
2916 void ext4_fc_track_unlink(handle_t *handle, struct dentry *dentry);
2917 void ext4_fc_track_link(handle_t *handle, struct dentry *dentry);
2918 void __ext4_fc_track_create(handle_t *handle, struct inode *inode,
2919                             struct dentry *dentry);
2920 void ext4_fc_track_create(handle_t *handle, struct dentry *dentry);
2921 void ext4_fc_track_inode(handle_t *handle, struct inode *inode);
2922 void ext4_fc_mark_ineligible(struct super_block *sb, int reason, handle_t *handle);
2923 void ext4_fc_start_update(struct inode *inode);
2924 void ext4_fc_stop_update(struct inode *inode);
2925 void ext4_fc_del(struct inode *inode);
2926 bool ext4_fc_replay_check_excluded(struct super_block *sb, ext4_fsblk_t block);
2927 void ext4_fc_replay_cleanup(struct super_block *sb);
2928 int ext4_fc_commit(journal_t *journal, tid_t commit_tid);
2929 int __init ext4_fc_init_dentry_cache(void);
2930 void ext4_fc_destroy_dentry_cache(void);
2931 int ext4_fc_record_regions(struct super_block *sb, int ino,
2932                            ext4_lblk_t lblk, ext4_fsblk_t pblk,
2933                            int len, int replay);
2934
2935 /* mballoc.c */
2936 extern const struct seq_operations ext4_mb_seq_groups_ops;
2937 extern const struct seq_operations ext4_mb_seq_structs_summary_ops;
2938 extern long ext4_mb_stats;
2939 extern long ext4_mb_max_to_scan;
2940 extern int ext4_seq_mb_stats_show(struct seq_file *seq, void *offset);
2941 extern int ext4_mb_init(struct super_block *);
2942 extern int ext4_mb_release(struct super_block *);
2943 extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
2944                                 struct ext4_allocation_request *, int *);
2945 extern int ext4_mb_reserve_blocks(struct super_block *, int);
2946 extern void ext4_discard_preallocations(struct inode *, unsigned int);
2947 extern int __init ext4_init_mballoc(void);
2948 extern void ext4_exit_mballoc(void);
2949 extern ext4_group_t ext4_mb_prefetch(struct super_block *sb,
2950                                      ext4_group_t group,
2951                                      unsigned int nr, int *cnt);
2952 extern void ext4_mb_prefetch_fini(struct super_block *sb, ext4_group_t group,
2953                                   unsigned int nr);
2954
2955 extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
2956                              struct buffer_head *bh, ext4_fsblk_t block,
2957                              unsigned long count, int flags);
2958 extern int ext4_mb_alloc_groupinfo(struct super_block *sb,
2959                                    ext4_group_t ngroups);
2960 extern int ext4_mb_add_groupinfo(struct super_block *sb,
2961                 ext4_group_t i, struct ext4_group_desc *desc);
2962 extern int ext4_group_add_blocks(handle_t *handle, struct super_block *sb,
2963                                 ext4_fsblk_t block, unsigned long count);
2964 extern int ext4_trim_fs(struct super_block *, struct fstrim_range *);
2965 extern void ext4_process_freed_data(struct super_block *sb, tid_t commit_tid);
2966 extern void ext4_mb_mark_bb(struct super_block *sb, ext4_fsblk_t block,
2967                        int len, int state);
2968
2969 /* inode.c */
2970 void ext4_inode_csum_set(struct inode *inode, struct ext4_inode *raw,
2971                          struct ext4_inode_info *ei);
2972 int ext4_inode_is_fast_symlink(struct inode *inode);
2973 struct buffer_head *ext4_getblk(handle_t *, struct inode *, ext4_lblk_t, int);
2974 struct buffer_head *ext4_bread(handle_t *, struct inode *, ext4_lblk_t, int);
2975 int ext4_bread_batch(struct inode *inode, ext4_lblk_t block, int bh_count,
2976                      bool wait, struct buffer_head **bhs);
2977 int ext4_get_block_unwritten(struct inode *inode, sector_t iblock,
2978                              struct buffer_head *bh_result, int create);
2979 int ext4_get_block(struct inode *inode, sector_t iblock,
2980                    struct buffer_head *bh_result, int create);
2981 int ext4_da_get_block_prep(struct inode *inode, sector_t iblock,
2982                            struct buffer_head *bh, int create);
2983 int ext4_walk_page_buffers(handle_t *handle,
2984                            struct inode *inode,
2985                            struct buffer_head *head,
2986                            unsigned from,
2987                            unsigned to,
2988                            int *partial,
2989                            int (*fn)(handle_t *handle, struct inode *inode,
2990                                      struct buffer_head *bh));
2991 int do_journal_get_write_access(handle_t *handle, struct inode *inode,
2992                                 struct buffer_head *bh);
2993 #define FALL_BACK_TO_NONDELALLOC 1
2994 #define CONVERT_INLINE_DATA      2
2995
2996 typedef enum {
2997         EXT4_IGET_NORMAL =      0,
2998         EXT4_IGET_SPECIAL =     0x0001, /* OK to iget a system inode */
2999         EXT4_IGET_HANDLE =      0x0002  /* Inode # is from a handle */
3000 } ext4_iget_flags;
3001
3002 extern struct inode *__ext4_iget(struct super_block *sb, unsigned long ino,
3003                                  ext4_iget_flags flags, const char *function,
3004                                  unsigned int line);
3005
3006 #define ext4_iget(sb, ino, flags) \
3007         __ext4_iget((sb), (ino), (flags), __func__, __LINE__)
3008
3009 extern int  ext4_write_inode(struct inode *, struct writeback_control *);
3010 extern int  ext4_setattr(struct user_namespace *, struct dentry *,
3011                          struct iattr *);
3012 extern int  ext4_getattr(struct user_namespace *, const struct path *,
3013                          struct kstat *, u32, unsigned int);
3014 extern void ext4_evict_inode(struct inode *);
3015 extern void ext4_clear_inode(struct inode *);
3016 extern int  ext4_file_getattr(struct user_namespace *, const struct path *,
3017                               struct kstat *, u32, unsigned int);
3018 extern int  ext4_sync_inode(handle_t *, struct inode *);
3019 extern void ext4_dirty_inode(struct inode *, int);
3020 extern int ext4_change_inode_journal_flag(struct inode *, int);
3021 extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
3022 extern int ext4_get_fc_inode_loc(struct super_block *sb, unsigned long ino,
3023                           struct ext4_iloc *iloc);
3024 extern int ext4_inode_attach_jinode(struct inode *inode);
3025 extern int ext4_can_truncate(struct inode *inode);
3026 extern int ext4_truncate(struct inode *);
3027 extern int ext4_break_layouts(struct inode *);
3028 extern int ext4_punch_hole(struct file *file, loff_t offset, loff_t length);
3029 extern void ext4_set_inode_flags(struct inode *, bool init);
3030 extern int ext4_alloc_da_blocks(struct inode *inode);
3031 extern void ext4_set_aops(struct inode *inode);
3032 extern int ext4_writepage_trans_blocks(struct inode *);
3033 extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
3034 extern int ext4_zero_partial_blocks(handle_t *handle, struct inode *inode,
3035                              loff_t lstart, loff_t lend);
3036 extern vm_fault_t ext4_page_mkwrite(struct vm_fault *vmf);
3037 extern qsize_t *ext4_get_reserved_space(struct inode *inode);
3038 extern int ext4_get_projid(struct inode *inode, kprojid_t *projid);
3039 extern void ext4_da_release_space(struct inode *inode, int to_free);
3040 extern void ext4_da_update_reserve_space(struct inode *inode,
3041                                         int used, int quota_claim);
3042 extern int ext4_issue_zeroout(struct inode *inode, ext4_lblk_t lblk,
3043                               ext4_fsblk_t pblk, ext4_lblk_t len);
3044
3045 /* indirect.c */
3046 extern int ext4_ind_map_blocks(handle_t *handle, struct inode *inode,
3047                                 struct ext4_map_blocks *map, int flags);
3048 extern int ext4_ind_trans_blocks(struct inode *inode, int nrblocks);
3049 extern void ext4_ind_truncate(handle_t *, struct inode *inode);
3050 extern int ext4_ind_remove_space(handle_t *handle, struct inode *inode,
3051                                  ext4_lblk_t start, ext4_lblk_t end);
3052
3053 /* ioctl.c */
3054 extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
3055 extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
3056 int ext4_fileattr_set(struct user_namespace *mnt_userns,
3057                       struct dentry *dentry, struct fileattr *fa);
3058 int ext4_fileattr_get(struct dentry *dentry, struct fileattr *fa);
3059 extern void ext4_reset_inode_seed(struct inode *inode);
3060
3061 /* migrate.c */
3062 extern int ext4_ext_migrate(struct inode *);
3063 extern int ext4_ind_migrate(struct inode *inode);
3064
3065 /* namei.c */
3066 extern int ext4_init_new_dir(handle_t *handle, struct inode *dir,
3067                              struct inode *inode);
3068 extern int ext4_dirblock_csum_verify(struct inode *inode,
3069                                      struct buffer_head *bh);
3070 extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
3071                                 __u32 start_minor_hash, __u32 *next_hash);
3072 extern int ext4_search_dir(struct buffer_head *bh,
3073                            char *search_buf,
3074                            int buf_size,
3075                            struct inode *dir,
3076                            struct ext4_filename *fname,
3077                            unsigned int offset,
3078                            struct ext4_dir_entry_2 **res_dir);
3079 extern int ext4_generic_delete_entry(struct inode *dir,
3080                                      struct ext4_dir_entry_2 *de_del,
3081                                      struct buffer_head *bh,
3082                                      void *entry_buf,
3083                                      int buf_size,
3084                                      int csum_size);
3085 extern bool ext4_empty_dir(struct inode *inode);
3086
3087 /* resize.c */
3088 extern void ext4_kvfree_array_rcu(void *to_free);
3089 extern int ext4_group_add(struct super_block *sb,
3090                                 struct ext4_new_group_data *input);
3091 extern int ext4_group_extend(struct super_block *sb,
3092                                 struct ext4_super_block *es,
3093                                 ext4_fsblk_t n_blocks_count);
3094 extern int ext4_resize_fs(struct super_block *sb, ext4_fsblk_t n_blocks_count);
3095
3096 /* super.c */
3097 extern struct buffer_head *ext4_sb_bread(struct super_block *sb,
3098                                          sector_t block, int op_flags);
3099 extern struct buffer_head *ext4_sb_bread_unmovable(struct super_block *sb,
3100                                                    sector_t block);
3101 extern void ext4_read_bh_nowait(struct buffer_head *bh, int op_flags,
3102                                 bh_end_io_t *end_io);
3103 extern int ext4_read_bh(struct buffer_head *bh, int op_flags,
3104                         bh_end_io_t *end_io);
3105 extern int ext4_read_bh_lock(struct buffer_head *bh, int op_flags, bool wait);
3106 extern void ext4_sb_breadahead_unmovable(struct super_block *sb, sector_t block);
3107 extern int ext4_seq_options_show(struct seq_file *seq, void *offset);
3108 extern int ext4_calculate_overhead(struct super_block *sb);
3109 extern void ext4_superblock_csum_set(struct super_block *sb);
3110 extern int ext4_alloc_flex_bg_array(struct super_block *sb,
3111                                     ext4_group_t ngroup);
3112 extern const char *ext4_decode_error(struct super_block *sb, int errno,
3113                                      char nbuf[16]);
3114 extern void ext4_mark_group_bitmap_corrupted(struct super_block *sb,
3115                                              ext4_group_t block_group,
3116                                              unsigned int flags);
3117
3118 extern __printf(7, 8)
3119 void __ext4_error(struct super_block *, const char *, unsigned int, bool,
3120                   int, __u64, const char *, ...);
3121 extern __printf(6, 7)
3122 void __ext4_error_inode(struct inode *, const char *, unsigned int,
3123                         ext4_fsblk_t, int, const char *, ...);
3124 extern __printf(5, 6)
3125 void __ext4_error_file(struct file *, const char *, unsigned int, ext4_fsblk_t,
3126                      const char *, ...);
3127 extern void __ext4_std_error(struct super_block *, const char *,
3128                              unsigned int, int);
3129 extern __printf(4, 5)
3130 void __ext4_warning(struct super_block *, const char *, unsigned int,
3131                     const char *, ...);
3132 extern __printf(4, 5)
3133 void __ext4_warning_inode(const struct inode *inode, const char *function,
3134                           unsigned int line, const char *fmt, ...);
3135 extern __printf(3, 4)
3136 void __ext4_msg(struct super_block *, const char *, const char *, ...);
3137 extern void __dump_mmp_msg(struct super_block *, struct mmp_struct *mmp,
3138                            const char *, unsigned int, const char *);
3139 extern __printf(7, 8)
3140 void __ext4_grp_locked_error(const char *, unsigned int,
3141                              struct super_block *, ext4_group_t,
3142                              unsigned long, ext4_fsblk_t,
3143                              const char *, ...);
3144
3145 #define EXT4_ERROR_INODE(inode, fmt, a...) \
3146         ext4_error_inode((inode), __func__, __LINE__, 0, (fmt), ## a)
3147
3148 #define EXT4_ERROR_INODE_ERR(inode, err, fmt, a...)                     \
3149         __ext4_error_inode((inode), __func__, __LINE__, 0, (err), (fmt), ## a)
3150
3151 #define ext4_error_inode_block(inode, block, err, fmt, a...)            \
3152         __ext4_error_inode((inode), __func__, __LINE__, (block), (err), \
3153                            (fmt), ## a)
3154
3155 #define EXT4_ERROR_FILE(file, block, fmt, a...)                         \
3156         ext4_error_file((file), __func__, __LINE__, (block), (fmt), ## a)
3157
3158 #define ext4_abort(sb, err, fmt, a...)                                  \
3159         __ext4_error((sb), __func__, __LINE__, true, (err), 0, (fmt), ## a)
3160
3161 #ifdef CONFIG_PRINTK
3162
3163 #define ext4_error_inode(inode, func, line, block, fmt, ...)            \
3164         __ext4_error_inode(inode, func, line, block, 0, fmt, ##__VA_ARGS__)
3165 #define ext4_error_inode_err(inode, func, line, block, err, fmt, ...)   \
3166         __ext4_error_inode((inode), (func), (line), (block),            \
3167                            (err), (fmt), ##__VA_ARGS__)
3168 #define ext4_error_file(file, func, line, block, fmt, ...)              \
3169         __ext4_error_file(file, func, line, block, fmt, ##__VA_ARGS__)
3170 #define ext4_error(sb, fmt, ...)                                        \
3171         __ext4_error((sb), __func__, __LINE__, false, 0, 0, (fmt),      \
3172                 ##__VA_ARGS__)
3173 #define ext4_error_err(sb, err, fmt, ...)                               \
3174         __ext4_error((sb), __func__, __LINE__, false, (err), 0, (fmt),  \
3175                 ##__VA_ARGS__)
3176 #define ext4_warning(sb, fmt, ...)                                      \
3177         __ext4_warning(sb, __func__, __LINE__, fmt, ##__VA_ARGS__)
3178 #define ext4_warning_inode(inode, fmt, ...)                             \
3179         __ext4_warning_inode(inode, __func__, __LINE__, fmt, ##__VA_ARGS__)
3180 #define ext4_msg(sb, level, fmt, ...)                           \
3181         __ext4_msg(sb, level, fmt, ##__VA_ARGS__)
3182 #define dump_mmp_msg(sb, mmp, msg)                                      \
3183         __dump_mmp_msg(sb, mmp, __func__, __LINE__, msg)
3184 #define ext4_grp_locked_error(sb, grp, ino, block, fmt, ...)            \
3185         __ext4_grp_locked_error(__func__, __LINE__, sb, grp, ino, block, \
3186                                 fmt, ##__VA_ARGS__)
3187
3188 #else
3189
3190 #define ext4_error_inode(inode, func, line, block, fmt, ...)            \
3191 do {                                                                    \
3192         no_printk(fmt, ##__VA_ARGS__);                                  \
3193         __ext4_error_inode(inode, "", 0, block, 0, " ");                \
3194 } while (0)
3195 #define ext4_error_inode_err(inode, func, line, block, err, fmt, ...)   \
3196 do {                                                                    \
3197         no_printk(fmt, ##__VA_ARGS__);                                  \
3198         __ext4_error_inode(inode, "", 0, block, err, " ");              \
3199 } while (0)
3200 #define ext4_error_file(file, func, line, block, fmt, ...)              \
3201 do {                                                                    \
3202         no_printk(fmt, ##__VA_ARGS__);                                  \
3203         __ext4_error_file(file, "", 0, block, " ");                     \
3204 } while (0)
3205 #define ext4_error(sb, fmt, ...)                                        \
3206 do {                                                                    \
3207         no_printk(fmt, ##__VA_ARGS__);                                  \
3208         __ext4_error(sb, "", 0, false, 0, 0, " ");                      \
3209 } while (0)
3210 #define ext4_error_err(sb, err, fmt, ...)                               \
3211 do {                                                                    \
3212         no_printk(fmt, ##__VA_ARGS__);                                  \
3213         __ext4_error(sb, "", 0, false, err, 0, " ");                    \
3214 } while (0)
3215 #define ext4_warning(sb, fmt, ...)                                      \
3216 do {                                                                    \
3217         no_printk(fmt, ##__VA_ARGS__);                                  \
3218         __ext4_warning(sb, "", 0, " ");                                 \
3219 } while (0)
3220 #define ext4_warning_inode(inode, fmt, ...)                             \
3221 do {                                                                    \
3222         no_printk(fmt, ##__VA_ARGS__);                                  \
3223         __ext4_warning_inode(inode, "", 0, " ");                        \
3224 } while (0)
3225 #define ext4_msg(sb, level, fmt, ...)                                   \
3226 do {                                                                    \
3227         no_printk(fmt, ##__VA_ARGS__);                                  \
3228         __ext4_msg(sb, "", " ");                                        \
3229 } while (0)
3230 #define dump_mmp_msg(sb, mmp, msg)                                      \
3231         __dump_mmp_msg(sb, mmp, "", 0, "")
3232 #define ext4_grp_locked_error(sb, grp, ino, block, fmt, ...)            \
3233 do {                                                                    \
3234         no_printk(fmt, ##__VA_ARGS__);                          \
3235         __ext4_grp_locked_error("", 0, sb, grp, ino, block, " ");       \
3236 } while (0)
3237
3238 #endif
3239
3240 extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
3241                                       struct ext4_group_desc *bg);
3242 extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
3243                                       struct ext4_group_desc *bg);
3244 extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
3245                                      struct ext4_group_desc *bg);
3246 extern __u32 ext4_free_group_clusters(struct super_block *sb,
3247                                       struct ext4_group_desc *bg);
3248 extern __u32 ext4_free_inodes_count(struct super_block *sb,
3249                                  struct ext4_group_desc *bg);
3250 extern __u32 ext4_used_dirs_count(struct super_block *sb,
3251                                 struct ext4_group_desc *bg);
3252 extern __u32 ext4_itable_unused_count(struct super_block *sb,
3253                                    struct ext4_group_desc *bg);
3254 extern void ext4_block_bitmap_set(struct super_block *sb,
3255                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
3256 extern void ext4_inode_bitmap_set(struct super_block *sb,
3257                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
3258 extern void ext4_inode_table_set(struct super_block *sb,
3259                                  struct ext4_group_desc *bg, ext4_fsblk_t blk);
3260 extern void ext4_free_group_clusters_set(struct super_block *sb,
3261                                          struct ext4_group_desc *bg,
3262                                          __u32 count);
3263 extern void ext4_free_inodes_set(struct super_block *sb,
3264                                 struct ext4_group_desc *bg, __u32 count);
3265 extern void ext4_used_dirs_set(struct super_block *sb,
3266                                 struct ext4_group_desc *bg, __u32 count);
3267 extern void ext4_itable_unused_set(struct super_block *sb,
3268                                    struct ext4_group_desc *bg, __u32 count);
3269 extern int ext4_group_desc_csum_verify(struct super_block *sb, __u32 group,
3270                                        struct ext4_group_desc *gdp);
3271 extern void ext4_group_desc_csum_set(struct super_block *sb, __u32 group,
3272                                      struct ext4_group_desc *gdp);
3273 extern int ext4_register_li_request(struct super_block *sb,
3274                                     ext4_group_t first_not_zeroed);
3275
3276 static inline int ext4_has_metadata_csum(struct super_block *sb)
3277 {
3278         WARN_ON_ONCE(ext4_has_feature_metadata_csum(sb) &&
3279                      !EXT4_SB(sb)->s_chksum_driver);
3280
3281         return ext4_has_feature_metadata_csum(sb) &&
3282                (EXT4_SB(sb)->s_chksum_driver != NULL);
3283 }
3284
3285 static inline int ext4_has_group_desc_csum(struct super_block *sb)
3286 {
3287         return ext4_has_feature_gdt_csum(sb) || ext4_has_metadata_csum(sb);
3288 }
3289
3290 #define ext4_read_incompat_64bit_val(es, name) \
3291         (((es)->s_feature_incompat & cpu_to_le32(EXT4_FEATURE_INCOMPAT_64BIT) \
3292                 ? (ext4_fsblk_t)le32_to_cpu(es->name##_hi) << 32 : 0) | \
3293                 le32_to_cpu(es->name##_lo))
3294
3295 static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
3296 {
3297         return ext4_read_incompat_64bit_val(es, s_blocks_count);
3298 }
3299
3300 static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
3301 {
3302         return ext4_read_incompat_64bit_val(es, s_r_blocks_count);
3303 }
3304
3305 static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
3306 {
3307         return ext4_read_incompat_64bit_val(es, s_free_blocks_count);
3308 }
3309
3310 static inline void ext4_blocks_count_set(struct ext4_super_block *es,
3311                                          ext4_fsblk_t blk)
3312 {
3313         es->s_blocks_count_lo = cpu_to_le32((u32)blk);
3314         es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
3315 }
3316
3317 static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
3318                                               ext4_fsblk_t blk)
3319 {
3320         es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
3321         es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
3322 }
3323
3324 static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
3325                                            ext4_fsblk_t blk)
3326 {
3327         es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
3328         es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
3329 }
3330
3331 static inline loff_t ext4_isize(struct super_block *sb,
3332                                 struct ext4_inode *raw_inode)
3333 {
3334         if (ext4_has_feature_largedir(sb) ||
3335             S_ISREG(le16_to_cpu(raw_inode->i_mode)))
3336                 return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
3337                         le32_to_cpu(raw_inode->i_size_lo);
3338
3339         return (loff_t) le32_to_cpu(raw_inode->i_size_lo);
3340 }
3341
3342 static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
3343 {
3344         raw_inode->i_size_lo = cpu_to_le32(i_size);
3345         raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
3346 }
3347
3348 static inline
3349 struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
3350                                             ext4_group_t group)
3351 {
3352          struct ext4_group_info **grp_info;
3353          long indexv, indexh;
3354          BUG_ON(group >= EXT4_SB(sb)->s_groups_count);
3355          indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
3356          indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
3357          grp_info = sbi_array_rcu_deref(EXT4_SB(sb), s_group_info, indexv);
3358          return grp_info[indexh];
3359 }
3360
3361 /*
3362  * Reading s_groups_count requires using smp_rmb() afterwards.  See
3363  * the locking protocol documented in the comments of ext4_group_add()
3364  * in resize.c
3365  */
3366 static inline ext4_group_t ext4_get_groups_count(struct super_block *sb)
3367 {
3368         ext4_group_t    ngroups = EXT4_SB(sb)->s_groups_count;
3369
3370         smp_rmb();
3371         return ngroups;
3372 }
3373
3374 static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
3375                                              ext4_group_t block_group)
3376 {
3377         return block_group >> sbi->s_log_groups_per_flex;
3378 }
3379
3380 static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
3381 {
3382         return 1 << sbi->s_log_groups_per_flex;
3383 }
3384
3385 #define ext4_std_error(sb, errno)                               \
3386 do {                                                            \
3387         if ((errno))                                            \
3388                 __ext4_std_error((sb), __func__, __LINE__, (errno));    \
3389 } while (0)
3390
3391 #ifdef CONFIG_SMP
3392 /* Each CPU can accumulate percpu_counter_batch clusters in their local
3393  * counters. So we need to make sure we have free clusters more
3394  * than percpu_counter_batch  * nr_cpu_ids. Also add a window of 4 times.
3395  */
3396 #define EXT4_FREECLUSTERS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
3397 #else
3398 #define EXT4_FREECLUSTERS_WATERMARK 0
3399 #endif
3400
3401 /* Update i_disksize. Requires i_mutex to avoid races with truncate */
3402 static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
3403 {
3404         WARN_ON_ONCE(S_ISREG(inode->i_mode) &&
3405                      !inode_is_locked(inode));
3406         down_write(&EXT4_I(inode)->i_data_sem);
3407         if (newsize > EXT4_I(inode)->i_disksize)
3408                 WRITE_ONCE(EXT4_I(inode)->i_disksize, newsize);
3409         up_write(&EXT4_I(inode)->i_data_sem);
3410 }
3411
3412 /* Update i_size, i_disksize. Requires i_mutex to avoid races with truncate */
3413 static inline int ext4_update_inode_size(struct inode *inode, loff_t newsize)
3414 {
3415         int changed = 0;
3416
3417         if (newsize > inode->i_size) {
3418                 i_size_write(inode, newsize);
3419                 changed = 1;
3420         }
3421         if (newsize > EXT4_I(inode)->i_disksize) {
3422                 ext4_update_i_disksize(inode, newsize);
3423                 changed |= 2;
3424         }
3425         return changed;
3426 }
3427
3428 int ext4_update_disksize_before_punch(struct inode *inode, loff_t offset,
3429                                       loff_t len);
3430
3431 struct ext4_group_info {
3432         unsigned long   bb_state;
3433 #ifdef AGGRESSIVE_CHECK
3434         unsigned long   bb_check_counter;
3435 #endif
3436         struct rb_root  bb_free_root;
3437         ext4_grpblk_t   bb_first_free;  /* first free block */
3438         ext4_grpblk_t   bb_free;        /* total free blocks */
3439         ext4_grpblk_t   bb_fragments;   /* nr of freespace fragments */
3440         ext4_grpblk_t   bb_largest_free_order;/* order of largest frag in BG */
3441         ext4_group_t    bb_group;       /* Group number */
3442         struct          list_head bb_prealloc_list;
3443 #ifdef DOUBLE_CHECK
3444         void            *bb_bitmap;
3445 #endif
3446         struct rw_semaphore alloc_sem;
3447         struct rb_node  bb_avg_fragment_size_rb;
3448         struct list_head bb_largest_free_order_node;
3449         ext4_grpblk_t   bb_counters[];  /* Nr of free power-of-two-block
3450                                          * regions, index is order.
3451                                          * bb_counters[3] = 5 means
3452                                          * 5 free 8-block regions. */
3453 };
3454
3455 #define EXT4_GROUP_INFO_NEED_INIT_BIT           0
3456 #define EXT4_GROUP_INFO_WAS_TRIMMED_BIT         1
3457 #define EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT     2
3458 #define EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT     3
3459 #define EXT4_GROUP_INFO_BBITMAP_CORRUPT         \
3460         (1 << EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT)
3461 #define EXT4_GROUP_INFO_IBITMAP_CORRUPT         \
3462         (1 << EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT)
3463 #define EXT4_GROUP_INFO_BBITMAP_READ_BIT        4
3464
3465 #define EXT4_MB_GRP_NEED_INIT(grp)      \
3466         (test_bit(EXT4_GROUP_INFO_NEED_INIT_BIT, &((grp)->bb_state)))
3467 #define EXT4_MB_GRP_BBITMAP_CORRUPT(grp)        \
3468         (test_bit(EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT, &((grp)->bb_state)))
3469 #define EXT4_MB_GRP_IBITMAP_CORRUPT(grp)        \
3470         (test_bit(EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT, &((grp)->bb_state)))
3471
3472 #define EXT4_MB_GRP_WAS_TRIMMED(grp)    \
3473         (test_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
3474 #define EXT4_MB_GRP_SET_TRIMMED(grp)    \
3475         (set_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
3476 #define EXT4_MB_GRP_CLEAR_TRIMMED(grp)  \
3477         (clear_bit(EXT4_GROUP_INFO_WAS_TRIMMED_BIT, &((grp)->bb_state)))
3478 #define EXT4_MB_GRP_TEST_AND_SET_READ(grp)      \
3479         (test_and_set_bit(EXT4_GROUP_INFO_BBITMAP_READ_BIT, &((grp)->bb_state)))
3480
3481 #define EXT4_MAX_CONTENTION             8
3482 #define EXT4_CONTENTION_THRESHOLD       2
3483
3484 static inline spinlock_t *ext4_group_lock_ptr(struct super_block *sb,
3485                                               ext4_group_t group)
3486 {
3487         return bgl_lock_ptr(EXT4_SB(sb)->s_blockgroup_lock, group);
3488 }
3489
3490 /*
3491  * Returns true if the filesystem is busy enough that attempts to
3492  * access the block group locks has run into contention.
3493  */
3494 static inline int ext4_fs_is_busy(struct ext4_sb_info *sbi)
3495 {
3496         return (atomic_read(&sbi->s_lock_busy) > EXT4_CONTENTION_THRESHOLD);
3497 }
3498
3499 static inline void ext4_lock_group(struct super_block *sb, ext4_group_t group)
3500 {
3501         spinlock_t *lock = ext4_group_lock_ptr(sb, group);
3502         if (spin_trylock(lock))
3503                 /*
3504                  * We're able to grab the lock right away, so drop the
3505                  * lock contention counter.
3506                  */
3507                 atomic_add_unless(&EXT4_SB(sb)->s_lock_busy, -1, 0);
3508         else {
3509                 /*
3510                  * The lock is busy, so bump the contention counter,
3511                  * and then wait on the spin lock.
3512                  */
3513                 atomic_add_unless(&EXT4_SB(sb)->s_lock_busy, 1,
3514                                   EXT4_MAX_CONTENTION);
3515                 spin_lock(lock);
3516         }
3517 }
3518
3519 static inline void ext4_unlock_group(struct super_block *sb,
3520                                         ext4_group_t group)
3521 {
3522         spin_unlock(ext4_group_lock_ptr(sb, group));
3523 }
3524
3525 #ifdef CONFIG_QUOTA
3526 static inline bool ext4_quota_capable(struct super_block *sb)
3527 {
3528         return (test_opt(sb, QUOTA) || ext4_has_feature_quota(sb));
3529 }
3530
3531 static inline bool ext4_is_quota_journalled(struct super_block *sb)
3532 {
3533         struct ext4_sb_info *sbi = EXT4_SB(sb);
3534
3535         return (ext4_has_feature_quota(sb) ||
3536                 sbi->s_qf_names[USRQUOTA] || sbi->s_qf_names[GRPQUOTA]);
3537 }
3538 int ext4_enable_quotas(struct super_block *sb);
3539 #endif
3540
3541 /*
3542  * Block validity checking
3543  */
3544 #define ext4_check_indirect_blockref(inode, bh)                         \
3545         ext4_check_blockref(__func__, __LINE__, inode,                  \
3546                             (__le32 *)(bh)->b_data,                     \
3547                             EXT4_ADDR_PER_BLOCK((inode)->i_sb))
3548
3549 #define ext4_ind_check_inode(inode)                                     \
3550         ext4_check_blockref(__func__, __LINE__, inode,                  \
3551                             EXT4_I(inode)->i_data,                      \
3552                             EXT4_NDIR_BLOCKS)
3553
3554 /*
3555  * Inodes and files operations
3556  */
3557
3558 /* dir.c */
3559 extern const struct file_operations ext4_dir_operations;
3560
3561 /* file.c */
3562 extern const struct inode_operations ext4_file_inode_operations;
3563 extern const struct file_operations ext4_file_operations;
3564 extern loff_t ext4_llseek(struct file *file, loff_t offset, int origin);
3565
3566 /* inline.c */
3567 extern int ext4_get_max_inline_size(struct inode *inode);
3568 extern int ext4_find_inline_data_nolock(struct inode *inode);
3569 extern int ext4_init_inline_data(handle_t *handle, struct inode *inode,
3570                                  unsigned int len);
3571 extern int ext4_destroy_inline_data(handle_t *handle, struct inode *inode);
3572
3573 extern int ext4_readpage_inline(struct inode *inode, struct page *page);
3574 extern int ext4_try_to_write_inline_data(struct address_space *mapping,
3575                                          struct inode *inode,
3576                                          loff_t pos, unsigned len,
3577                                          unsigned flags,
3578                                          struct page **pagep);
3579 extern int ext4_write_inline_data_end(struct inode *inode,
3580                                       loff_t pos, unsigned len,
3581                                       unsigned copied,
3582                                       struct page *page);
3583 extern struct buffer_head *
3584 ext4_journalled_write_inline_data(struct inode *inode,
3585                                   unsigned len,
3586                                   struct page *page);
3587 extern int ext4_da_write_inline_data_begin(struct address_space *mapping,
3588                                            struct inode *inode,
3589                                            loff_t pos, unsigned len,
3590                                            unsigned flags,
3591                                            struct page **pagep,
3592                                            void **fsdata);
3593 extern int ext4_try_add_inline_entry(handle_t *handle,
3594                                      struct ext4_filename *fname,
3595                                      struct inode *dir, struct inode *inode);
3596 extern int ext4_try_create_inline_dir(handle_t *handle,
3597                                       struct inode *parent,
3598                                       struct inode *inode);
3599 extern int ext4_read_inline_dir(struct file *filp,
3600                                 struct dir_context *ctx,
3601                                 int *has_inline_data);
3602 extern int ext4_inlinedir_to_tree(struct file *dir_file,
3603                                   struct inode *dir, ext4_lblk_t block,
3604                                   struct dx_hash_info *hinfo,
3605                                   __u32 start_hash, __u32 start_minor_hash,
3606                                   int *has_inline_data);
3607 extern struct buffer_head *ext4_find_inline_entry(struct inode *dir,
3608                                         struct ext4_filename *fname,
3609                                         struct ext4_dir_entry_2 **res_dir,
3610                                         int *has_inline_data);
3611 extern int ext4_delete_inline_entry(handle_t *handle,
3612                                     struct inode *dir,
3613                                     struct ext4_dir_entry_2 *de_del,
3614                                     struct buffer_head *bh,
3615                                     int *has_inline_data);
3616 extern bool empty_inline_dir(struct inode *dir, int *has_inline_data);
3617 extern struct buffer_head *ext4_get_first_inline_block(struct inode *inode,
3618                                         struct ext4_dir_entry_2 **parent_de,
3619                                         int *retval);
3620 extern int ext4_inline_data_fiemap(struct inode *inode,
3621                                    struct fiemap_extent_info *fieinfo,
3622                                    int *has_inline, __u64 start, __u64 len);
3623
3624 struct iomap;
3625 extern int ext4_inline_data_iomap(struct inode *inode, struct iomap *iomap);
3626
3627 extern int ext4_inline_data_truncate(struct inode *inode, int *has_inline);
3628
3629 extern int ext4_convert_inline_data(struct inode *inode);
3630
3631 static inline int ext4_has_inline_data(struct inode *inode)
3632 {
3633         return ext4_test_inode_flag(inode, EXT4_INODE_INLINE_DATA) &&
3634                EXT4_I(inode)->i_inline_off;
3635 }
3636
3637 /* namei.c */
3638 extern const struct inode_operations ext4_dir_inode_operations;
3639 extern const struct inode_operations ext4_special_inode_operations;
3640 extern struct dentry *ext4_get_parent(struct dentry *child);
3641 extern struct ext4_dir_entry_2 *ext4_init_dot_dotdot(struct inode *inode,
3642                                  struct ext4_dir_entry_2 *de,
3643                                  int blocksize, int csum_size,
3644                                  unsigned int parent_ino, int dotdot_real_len);
3645 extern void ext4_initialize_dirent_tail(struct buffer_head *bh,
3646                                         unsigned int blocksize);
3647 extern int ext4_handle_dirty_dirblock(handle_t *handle, struct inode *inode,
3648                                       struct buffer_head *bh);
3649 extern int __ext4_unlink(handle_t *handle, struct inode *dir, const struct qstr *d_name,
3650                          struct inode *inode);
3651 extern int __ext4_link(struct inode *dir, struct inode *inode,
3652                        struct dentry *dentry);
3653
3654 #define S_SHIFT 12
3655 static const unsigned char ext4_type_by_mode[(S_IFMT >> S_SHIFT) + 1] = {
3656         [S_IFREG >> S_SHIFT]    = EXT4_FT_REG_FILE,
3657         [S_IFDIR >> S_SHIFT]    = EXT4_FT_DIR,
3658         [S_IFCHR >> S_SHIFT]    = EXT4_FT_CHRDEV,
3659         [S_IFBLK >> S_SHIFT]    = EXT4_FT_BLKDEV,
3660         [S_IFIFO >> S_SHIFT]    = EXT4_FT_FIFO,
3661         [S_IFSOCK >> S_SHIFT]   = EXT4_FT_SOCK,
3662         [S_IFLNK >> S_SHIFT]    = EXT4_FT_SYMLINK,
3663 };
3664
3665 static inline void ext4_set_de_type(struct super_block *sb,
3666                                 struct ext4_dir_entry_2 *de,
3667                                 umode_t mode) {
3668         if (ext4_has_feature_filetype(sb))
3669                 de->file_type = ext4_type_by_mode[(mode & S_IFMT)>>S_SHIFT];
3670 }
3671
3672 /* readpages.c */
3673 extern int ext4_mpage_readpages(struct inode *inode,
3674                 struct readahead_control *rac, struct page *page);
3675 extern int __init ext4_init_post_read_processing(void);
3676 extern void ext4_exit_post_read_processing(void);
3677
3678 /* symlink.c */
3679 extern const struct inode_operations ext4_encrypted_symlink_inode_operations;
3680 extern const struct inode_operations ext4_symlink_inode_operations;
3681 extern const struct inode_operations ext4_fast_symlink_inode_operations;
3682
3683 /* sysfs.c */
3684 extern void ext4_notify_error_sysfs(struct ext4_sb_info *sbi);
3685 extern int ext4_register_sysfs(struct super_block *sb);
3686 extern void ext4_unregister_sysfs(struct super_block *sb);
3687 extern int __init ext4_init_sysfs(void);
3688 extern void ext4_exit_sysfs(void);
3689
3690 /* block_validity */
3691 extern void ext4_release_system_zone(struct super_block *sb);
3692 extern int ext4_setup_system_zone(struct super_block *sb);
3693 extern int __init ext4_init_system_zone(void);
3694 extern void ext4_exit_system_zone(void);
3695 extern int ext4_inode_block_valid(struct inode *inode,
3696                                   ext4_fsblk_t start_blk,
3697                                   unsigned int count);
3698 extern int ext4_check_blockref(const char *, unsigned int,
3699                                struct inode *, __le32 *, unsigned int);
3700
3701 /* extents.c */
3702 struct ext4_ext_path;
3703 struct ext4_extent;
3704
3705 /*
3706  * Maximum number of logical blocks in a file; ext4_extent's ee_block is
3707  * __le32.
3708  */
3709 #define EXT_MAX_BLOCKS  0xffffffff
3710
3711 extern void ext4_ext_tree_init(handle_t *handle, struct inode *inode);
3712 extern int ext4_ext_index_trans_blocks(struct inode *inode, int extents);
3713 extern int ext4_ext_map_blocks(handle_t *handle, struct inode *inode,
3714                                struct ext4_map_blocks *map, int flags);
3715 extern int ext4_ext_truncate(handle_t *, struct inode *);
3716 extern int ext4_ext_remove_space(struct inode *inode, ext4_lblk_t start,
3717                                  ext4_lblk_t end);
3718 extern void ext4_ext_init(struct super_block *);
3719 extern void ext4_ext_release(struct super_block *);
3720 extern long ext4_fallocate(struct file *file, int mode, loff_t offset,
3721                           loff_t len);
3722 extern int ext4_convert_unwritten_extents(handle_t *handle, struct inode *inode,
3723                                           loff_t offset, ssize_t len);
3724 extern int ext4_convert_unwritten_io_end_vec(handle_t *handle,
3725                                              ext4_io_end_t *io_end);
3726 extern int ext4_map_blocks(handle_t *handle, struct inode *inode,
3727                            struct ext4_map_blocks *map, int flags);
3728 extern int ext4_ext_calc_credits_for_single_extent(struct inode *inode,
3729                                                    int num,
3730                                                    struct ext4_ext_path *path);
3731 extern int ext4_ext_insert_extent(handle_t *, struct inode *,
3732                                   struct ext4_ext_path **,
3733                                   struct ext4_extent *, int);
3734 extern struct ext4_ext_path *ext4_find_extent(struct inode *, ext4_lblk_t,
3735                                               struct ext4_ext_path **,
3736                                               int flags);
3737 extern void ext4_ext_drop_refs(struct ext4_ext_path *);
3738 extern int ext4_ext_check_inode(struct inode *inode);
3739 extern ext4_lblk_t ext4_ext_next_allocated_block(struct ext4_ext_path *path);
3740 extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
3741                         __u64 start, __u64 len);
3742 extern int ext4_get_es_cache(struct inode *inode,
3743                              struct fiemap_extent_info *fieinfo,
3744                              __u64 start, __u64 len);
3745 extern int ext4_ext_precache(struct inode *inode);
3746 extern int ext4_swap_extents(handle_t *handle, struct inode *inode1,
3747                                 struct inode *inode2, ext4_lblk_t lblk1,
3748                              ext4_lblk_t lblk2,  ext4_lblk_t count,
3749                              int mark_unwritten,int *err);
3750 extern int ext4_clu_mapped(struct inode *inode, ext4_lblk_t lclu);
3751 extern int ext4_datasem_ensure_credits(handle_t *handle, struct inode *inode,
3752                                        int check_cred, int restart_cred,
3753                                        int revoke_cred);
3754 extern void ext4_ext_replay_shrink_inode(struct inode *inode, ext4_lblk_t end);
3755 extern int ext4_ext_replay_set_iblocks(struct inode *inode);
3756 extern int ext4_ext_replay_update_ex(struct inode *inode, ext4_lblk_t start,
3757                 int len, int unwritten, ext4_fsblk_t pblk);
3758 extern int ext4_ext_clear_bb(struct inode *inode);
3759
3760
3761 /* move_extent.c */
3762 extern void ext4_double_down_write_data_sem(struct inode *first,
3763                                             struct inode *second);
3764 extern void ext4_double_up_write_data_sem(struct inode *orig_inode,
3765                                           struct inode *donor_inode);
3766 extern int ext4_move_extents(struct file *o_filp, struct file *d_filp,
3767                              __u64 start_orig, __u64 start_donor,
3768                              __u64 len, __u64 *moved_len);
3769
3770 /* page-io.c */
3771 extern int __init ext4_init_pageio(void);
3772 extern void ext4_exit_pageio(void);
3773 extern ext4_io_end_t *ext4_init_io_end(struct inode *inode, gfp_t flags);
3774 extern ext4_io_end_t *ext4_get_io_end(ext4_io_end_t *io_end);
3775 extern int ext4_put_io_end(ext4_io_end_t *io_end);
3776 extern void ext4_put_io_end_defer(ext4_io_end_t *io_end);
3777 extern void ext4_io_submit_init(struct ext4_io_submit *io,
3778                                 struct writeback_control *wbc);
3779 extern void ext4_end_io_rsv_work(struct work_struct *work);
3780 extern void ext4_io_submit(struct ext4_io_submit *io);
3781 extern int ext4_bio_write_page(struct ext4_io_submit *io,
3782                                struct page *page,
3783                                int len,
3784                                bool keep_towrite);
3785 extern struct ext4_io_end_vec *ext4_alloc_io_end_vec(ext4_io_end_t *io_end);
3786 extern struct ext4_io_end_vec *ext4_last_io_end_vec(ext4_io_end_t *io_end);
3787
3788 /* mmp.c */
3789 extern int ext4_multi_mount_protect(struct super_block *, ext4_fsblk_t);
3790
3791 /* mmp.c */
3792 extern void ext4_stop_mmpd(struct ext4_sb_info *sbi);
3793
3794 /* verity.c */
3795 extern const struct fsverity_operations ext4_verityops;
3796
3797 /* orphan.c */
3798 extern int ext4_orphan_add(handle_t *, struct inode *);
3799 extern int ext4_orphan_del(handle_t *, struct inode *);
3800 extern void ext4_orphan_cleanup(struct super_block *sb,
3801                                 struct ext4_super_block *es);
3802 extern void ext4_release_orphan_info(struct super_block *sb);
3803 extern int ext4_init_orphan_info(struct super_block *sb);
3804 extern int ext4_orphan_file_empty(struct super_block *sb);
3805 extern void ext4_orphan_file_block_trigger(
3806                                 struct jbd2_buffer_trigger_type *triggers,
3807                                 struct buffer_head *bh,
3808                                 void *data, size_t size);
3809
3810 /*
3811  * Add new method to test whether block and inode bitmaps are properly
3812  * initialized. With uninit_bg reading the block from disk is not enough
3813  * to mark the bitmap uptodate. We need to also zero-out the bitmap
3814  */
3815 #define BH_BITMAP_UPTODATE BH_JBDPrivateStart
3816
3817 static inline int bitmap_uptodate(struct buffer_head *bh)
3818 {
3819         return (buffer_uptodate(bh) &&
3820                         test_bit(BH_BITMAP_UPTODATE, &(bh)->b_state));
3821 }
3822 static inline void set_bitmap_uptodate(struct buffer_head *bh)
3823 {
3824         set_bit(BH_BITMAP_UPTODATE, &(bh)->b_state);
3825 }
3826
3827 #define in_range(b, first, len) ((b) >= (first) && (b) <= (first) + (len) - 1)
3828
3829 /* For ioend & aio unwritten conversion wait queues */
3830 #define EXT4_WQ_HASH_SZ         37
3831 #define ext4_ioend_wq(v)   (&ext4__ioend_wq[((unsigned long)(v)) %\
3832                                             EXT4_WQ_HASH_SZ])
3833 extern wait_queue_head_t ext4__ioend_wq[EXT4_WQ_HASH_SZ];
3834
3835 extern int ext4_resize_begin(struct super_block *sb);
3836 extern void ext4_resize_end(struct super_block *sb);
3837
3838 static inline void ext4_set_io_unwritten_flag(struct inode *inode,
3839                                               struct ext4_io_end *io_end)
3840 {
3841         if (!(io_end->flag & EXT4_IO_END_UNWRITTEN)) {
3842                 io_end->flag |= EXT4_IO_END_UNWRITTEN;
3843                 atomic_inc(&EXT4_I(inode)->i_unwritten);
3844         }
3845 }
3846
3847 static inline void ext4_clear_io_unwritten_flag(ext4_io_end_t *io_end)
3848 {
3849         struct inode *inode = io_end->inode;
3850
3851         if (io_end->flag & EXT4_IO_END_UNWRITTEN) {
3852                 io_end->flag &= ~EXT4_IO_END_UNWRITTEN;
3853                 /* Wake up anyone waiting on unwritten extent conversion */
3854                 if (atomic_dec_and_test(&EXT4_I(inode)->i_unwritten))
3855                         wake_up_all(ext4_ioend_wq(inode));
3856         }
3857 }
3858
3859 extern const struct iomap_ops ext4_iomap_ops;
3860 extern const struct iomap_ops ext4_iomap_overwrite_ops;
3861 extern const struct iomap_ops ext4_iomap_report_ops;
3862
3863 static inline int ext4_buffer_uptodate(struct buffer_head *bh)
3864 {
3865         /*
3866          * If the buffer has the write error flag, we have failed
3867          * to write out data in the block.  In this  case, we don't
3868          * have to read the block because we may read the old data
3869          * successfully.
3870          */
3871         if (buffer_write_io_error(bh))
3872                 set_buffer_uptodate(bh);
3873         return buffer_uptodate(bh);
3874 }
3875
3876 #endif  /* __KERNEL__ */
3877
3878 #define EFSBADCRC       EBADMSG         /* Bad CRC detected */
3879 #define EFSCORRUPTED    EUCLEAN         /* Filesystem is corrupted */
3880
3881 #endif  /* _EXT4_H */