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