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