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