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