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