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