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