ext4: New rec_len encoding for very large blocksizes
[safe/jmp/linux-2.6] / 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 "ext4_i.h"
25
26 /*
27  * The fourth extended filesystem constants/structures
28  */
29
30 /*
31  * Define EXT4FS_DEBUG to produce debug messages
32  */
33 #undef EXT4FS_DEBUG
34
35 /*
36  * Debug code
37  */
38 #ifdef EXT4FS_DEBUG
39 #define ext4_debug(f, a...)                                             \
40         do {                                                            \
41                 printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:",        \
42                         __FILE__, __LINE__, __func__);                  \
43                 printk(KERN_DEBUG f, ## a);                             \
44         } while (0)
45 #else
46 #define ext4_debug(f, a...)     do {} while (0)
47 #endif
48
49 /* prefer goal again. length */
50 #define EXT4_MB_HINT_MERGE              1
51 /* blocks already reserved */
52 #define EXT4_MB_HINT_RESERVED           2
53 /* metadata is being allocated */
54 #define EXT4_MB_HINT_METADATA           4
55 /* first blocks in the file */
56 #define EXT4_MB_HINT_FIRST              8
57 /* search for the best chunk */
58 #define EXT4_MB_HINT_BEST               16
59 /* data is being allocated */
60 #define EXT4_MB_HINT_DATA               32
61 /* don't preallocate (for tails) */
62 #define EXT4_MB_HINT_NOPREALLOC         64
63 /* allocate for locality group */
64 #define EXT4_MB_HINT_GROUP_ALLOC        128
65 /* allocate goal blocks or none */
66 #define EXT4_MB_HINT_GOAL_ONLY          256
67 /* goal is meaningful */
68 #define EXT4_MB_HINT_TRY_GOAL           512
69 /* blocks already pre-reserved by delayed allocation */
70 #define EXT4_MB_DELALLOC_RESERVED      1024
71
72
73 struct ext4_allocation_request {
74         /* target inode for block we're allocating */
75         struct inode *inode;
76         /* logical block in target inode */
77         ext4_lblk_t logical;
78         /* phys. target (a hint) */
79         ext4_fsblk_t goal;
80         /* the closest logical allocated block to the left */
81         ext4_lblk_t lleft;
82         /* phys. block for ^^^ */
83         ext4_fsblk_t pleft;
84         /* the closest logical allocated block to the right */
85         ext4_lblk_t lright;
86         /* phys. block for ^^^ */
87         ext4_fsblk_t pright;
88         /* how many blocks we want to allocate */
89         unsigned int len;
90         /* flags. see above EXT4_MB_HINT_* */
91         unsigned int flags;
92 };
93
94 /*
95  * Special inodes numbers
96  */
97 #define EXT4_BAD_INO             1      /* Bad blocks inode */
98 #define EXT4_ROOT_INO            2      /* Root inode */
99 #define EXT4_BOOT_LOADER_INO     5      /* Boot loader inode */
100 #define EXT4_UNDEL_DIR_INO       6      /* Undelete directory inode */
101 #define EXT4_RESIZE_INO          7      /* Reserved group descriptors inode */
102 #define EXT4_JOURNAL_INO         8      /* Journal inode */
103
104 /* First non-reserved inode for old ext4 filesystems */
105 #define EXT4_GOOD_OLD_FIRST_INO 11
106
107 /*
108  * Maximal count of links to a file
109  */
110 #define EXT4_LINK_MAX           65000
111
112 /*
113  * Macro-instructions used to manage several block sizes
114  */
115 #define EXT4_MIN_BLOCK_SIZE             1024
116 #define EXT4_MAX_BLOCK_SIZE             65536
117 #define EXT4_MIN_BLOCK_LOG_SIZE         10
118 #ifdef __KERNEL__
119 # define EXT4_BLOCK_SIZE(s)             ((s)->s_blocksize)
120 #else
121 # define EXT4_BLOCK_SIZE(s)             (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
122 #endif
123 #define EXT4_ADDR_PER_BLOCK(s)          (EXT4_BLOCK_SIZE(s) / sizeof(__u32))
124 #ifdef __KERNEL__
125 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_blocksize_bits)
126 #else
127 # define EXT4_BLOCK_SIZE_BITS(s)        ((s)->s_log_block_size + 10)
128 #endif
129 #ifdef __KERNEL__
130 #define EXT4_ADDR_PER_BLOCK_BITS(s)     (EXT4_SB(s)->s_addr_per_block_bits)
131 #define EXT4_INODE_SIZE(s)              (EXT4_SB(s)->s_inode_size)
132 #define EXT4_FIRST_INO(s)               (EXT4_SB(s)->s_first_ino)
133 #else
134 #define EXT4_INODE_SIZE(s)      (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
135                                  EXT4_GOOD_OLD_INODE_SIZE : \
136                                  (s)->s_inode_size)
137 #define EXT4_FIRST_INO(s)       (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
138                                  EXT4_GOOD_OLD_FIRST_INO : \
139                                  (s)->s_first_ino)
140 #endif
141 #define EXT4_BLOCK_ALIGN(size, blkbits)         ALIGN((size), (1 << (blkbits)))
142
143 /*
144  * Structure of a blocks group descriptor
145  */
146 struct ext4_group_desc
147 {
148         __le32  bg_block_bitmap_lo;     /* Blocks bitmap block */
149         __le32  bg_inode_bitmap_lo;     /* Inodes bitmap block */
150         __le32  bg_inode_table_lo;      /* Inodes table block */
151         __le16  bg_free_blocks_count_lo;/* Free blocks count */
152         __le16  bg_free_inodes_count_lo;/* Free inodes count */
153         __le16  bg_used_dirs_count_lo;  /* Directories count */
154         __le16  bg_flags;               /* EXT4_BG_flags (INODE_UNINIT, etc) */
155         __u32   bg_reserved[2];         /* Likely block/inode bitmap checksum */
156         __le16  bg_itable_unused_lo;    /* Unused inodes count */
157         __le16  bg_checksum;            /* crc16(sb_uuid+group+desc) */
158         __le32  bg_block_bitmap_hi;     /* Blocks bitmap block MSB */
159         __le32  bg_inode_bitmap_hi;     /* Inodes bitmap block MSB */
160         __le32  bg_inode_table_hi;      /* Inodes table block MSB */
161         __le16  bg_free_blocks_count_hi;/* Free blocks count MSB */
162         __le16  bg_free_inodes_count_hi;/* Free inodes count MSB */
163         __le16  bg_used_dirs_count_hi;  /* Directories count MSB */
164         __le16  bg_itable_unused_hi;    /* Unused inodes count MSB */
165         __u32   bg_reserved2[3];
166 };
167
168 /*
169  * Structure of a flex block group info
170  */
171
172 struct flex_groups {
173         __u32 free_inodes;
174         __u32 free_blocks;
175 };
176
177 #define EXT4_BG_INODE_UNINIT    0x0001 /* Inode table/bitmap not in use */
178 #define EXT4_BG_BLOCK_UNINIT    0x0002 /* Block bitmap not in use */
179 #define EXT4_BG_INODE_ZEROED    0x0004 /* On-disk itable initialized to zero */
180
181 #ifdef __KERNEL__
182 #include "ext4_sb.h"
183 #endif
184 /*
185  * Macro-instructions used to manage group descriptors
186  */
187 #define EXT4_MIN_DESC_SIZE              32
188 #define EXT4_MIN_DESC_SIZE_64BIT        64
189 #define EXT4_MAX_DESC_SIZE              EXT4_MIN_BLOCK_SIZE
190 #define EXT4_DESC_SIZE(s)               (EXT4_SB(s)->s_desc_size)
191 #ifdef __KERNEL__
192 # define EXT4_BLOCKS_PER_GROUP(s)       (EXT4_SB(s)->s_blocks_per_group)
193 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_SB(s)->s_desc_per_block)
194 # define EXT4_INODES_PER_GROUP(s)       (EXT4_SB(s)->s_inodes_per_group)
195 # define EXT4_DESC_PER_BLOCK_BITS(s)    (EXT4_SB(s)->s_desc_per_block_bits)
196 #else
197 # define EXT4_BLOCKS_PER_GROUP(s)       ((s)->s_blocks_per_group)
198 # define EXT4_DESC_PER_BLOCK(s)         (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
199 # define EXT4_INODES_PER_GROUP(s)       ((s)->s_inodes_per_group)
200 #endif
201
202 /*
203  * Constants relative to the data blocks
204  */
205 #define EXT4_NDIR_BLOCKS                12
206 #define EXT4_IND_BLOCK                  EXT4_NDIR_BLOCKS
207 #define EXT4_DIND_BLOCK                 (EXT4_IND_BLOCK + 1)
208 #define EXT4_TIND_BLOCK                 (EXT4_DIND_BLOCK + 1)
209 #define EXT4_N_BLOCKS                   (EXT4_TIND_BLOCK + 1)
210
211 /*
212  * Inode flags
213  */
214 #define EXT4_SECRM_FL                   0x00000001 /* Secure deletion */
215 #define EXT4_UNRM_FL                    0x00000002 /* Undelete */
216 #define EXT4_COMPR_FL                   0x00000004 /* Compress file */
217 #define EXT4_SYNC_FL                    0x00000008 /* Synchronous updates */
218 #define EXT4_IMMUTABLE_FL               0x00000010 /* Immutable file */
219 #define EXT4_APPEND_FL                  0x00000020 /* writes to file may only append */
220 #define EXT4_NODUMP_FL                  0x00000040 /* do not dump file */
221 #define EXT4_NOATIME_FL                 0x00000080 /* do not update atime */
222 /* Reserved for compression usage... */
223 #define EXT4_DIRTY_FL                   0x00000100
224 #define EXT4_COMPRBLK_FL                0x00000200 /* One or more compressed clusters */
225 #define EXT4_NOCOMPR_FL                 0x00000400 /* Don't compress */
226 #define EXT4_ECOMPR_FL                  0x00000800 /* Compression error */
227 /* End compression flags --- maybe not all used */
228 #define EXT4_INDEX_FL                   0x00001000 /* hash-indexed directory */
229 #define EXT4_IMAGIC_FL                  0x00002000 /* AFS directory */
230 #define EXT4_JOURNAL_DATA_FL            0x00004000 /* file data should be journaled */
231 #define EXT4_NOTAIL_FL                  0x00008000 /* file tail should not be merged */
232 #define EXT4_DIRSYNC_FL                 0x00010000 /* dirsync behaviour (directories only) */
233 #define EXT4_TOPDIR_FL                  0x00020000 /* Top of directory hierarchies*/
234 #define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
235 #define EXT4_EXTENTS_FL                 0x00080000 /* Inode uses extents */
236 #define EXT4_EXT_MIGRATE                0x00100000 /* Inode is migrating */
237 #define EXT4_RESERVED_FL                0x80000000 /* reserved for ext4 lib */
238
239 #define EXT4_FL_USER_VISIBLE            0x000BDFFF /* User visible flags */
240 #define EXT4_FL_USER_MODIFIABLE         0x000B80FF /* User modifiable flags */
241
242 /*
243  * Inode dynamic state flags
244  */
245 #define EXT4_STATE_JDATA                0x00000001 /* journaled data exists */
246 #define EXT4_STATE_NEW                  0x00000002 /* inode is newly created */
247 #define EXT4_STATE_XATTR                0x00000004 /* has in-inode xattrs */
248 #define EXT4_STATE_NO_EXPAND            0x00000008 /* No space for expansion */
249
250 /* Used to pass group descriptor data when online resize is done */
251 struct ext4_new_group_input {
252         __u32 group;            /* Group number for this data */
253         __u64 block_bitmap;     /* Absolute block number of block bitmap */
254         __u64 inode_bitmap;     /* Absolute block number of inode bitmap */
255         __u64 inode_table;      /* Absolute block number of inode table start */
256         __u32 blocks_count;     /* Total number of blocks in this group */
257         __u16 reserved_blocks;  /* Number of reserved blocks in this group */
258         __u16 unused;
259 };
260
261 /* The struct ext4_new_group_input in kernel space, with free_blocks_count */
262 struct ext4_new_group_data {
263         __u32 group;
264         __u64 block_bitmap;
265         __u64 inode_bitmap;
266         __u64 inode_table;
267         __u32 blocks_count;
268         __u16 reserved_blocks;
269         __u16 unused;
270         __u32 free_blocks_count;
271 };
272
273 /*
274  * Following is used by preallocation code to tell get_blocks() that we
275  * want uninitialzed extents.
276  */
277 #define EXT4_CREATE_UNINITIALIZED_EXT           2
278
279 /*
280  * ioctl commands
281  */
282 #define EXT4_IOC_GETFLAGS               FS_IOC_GETFLAGS
283 #define EXT4_IOC_SETFLAGS               FS_IOC_SETFLAGS
284 #define EXT4_IOC_GETVERSION             _IOR('f', 3, long)
285 #define EXT4_IOC_SETVERSION             _IOW('f', 4, long)
286 #define EXT4_IOC_GETVERSION_OLD         FS_IOC_GETVERSION
287 #define EXT4_IOC_SETVERSION_OLD         FS_IOC_SETVERSION
288 #ifdef CONFIG_JBD2_DEBUG
289 #define EXT4_IOC_WAIT_FOR_READONLY      _IOR('f', 99, long)
290 #endif
291 #define EXT4_IOC_GETRSVSZ               _IOR('f', 5, long)
292 #define EXT4_IOC_SETRSVSZ               _IOW('f', 6, long)
293 #define EXT4_IOC_GROUP_EXTEND           _IOW('f', 7, unsigned long)
294 #define EXT4_IOC_GROUP_ADD              _IOW('f', 8, struct ext4_new_group_input)
295 #define EXT4_IOC_MIGRATE                _IO('f', 9)
296  /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
297
298 /*
299  * ioctl commands in 32 bit emulation
300  */
301 #define EXT4_IOC32_GETFLAGS             FS_IOC32_GETFLAGS
302 #define EXT4_IOC32_SETFLAGS             FS_IOC32_SETFLAGS
303 #define EXT4_IOC32_GETVERSION           _IOR('f', 3, int)
304 #define EXT4_IOC32_SETVERSION           _IOW('f', 4, int)
305 #define EXT4_IOC32_GETRSVSZ             _IOR('f', 5, int)
306 #define EXT4_IOC32_SETRSVSZ             _IOW('f', 6, int)
307 #define EXT4_IOC32_GROUP_EXTEND         _IOW('f', 7, unsigned int)
308 #ifdef CONFIG_JBD2_DEBUG
309 #define EXT4_IOC32_WAIT_FOR_READONLY    _IOR('f', 99, int)
310 #endif
311 #define EXT4_IOC32_GETVERSION_OLD       FS_IOC32_GETVERSION
312 #define EXT4_IOC32_SETVERSION_OLD       FS_IOC32_SETVERSION
313
314
315 /*
316  *  Mount options
317  */
318 struct ext4_mount_options {
319         unsigned long s_mount_opt;
320         uid_t s_resuid;
321         gid_t s_resgid;
322         unsigned long s_commit_interval;
323         u32 s_min_batch_time, s_max_batch_time;
324 #ifdef CONFIG_QUOTA
325         int s_jquota_fmt;
326         char *s_qf_names[MAXQUOTAS];
327 #endif
328 };
329
330 /*
331  * Structure of an inode on the disk
332  */
333 struct ext4_inode {
334         __le16  i_mode;         /* File mode */
335         __le16  i_uid;          /* Low 16 bits of Owner Uid */
336         __le32  i_size_lo;      /* Size in bytes */
337         __le32  i_atime;        /* Access time */
338         __le32  i_ctime;        /* Inode Change time */
339         __le32  i_mtime;        /* Modification time */
340         __le32  i_dtime;        /* Deletion Time */
341         __le16  i_gid;          /* Low 16 bits of Group Id */
342         __le16  i_links_count;  /* Links count */
343         __le32  i_blocks_lo;    /* Blocks count */
344         __le32  i_flags;        /* File flags */
345         union {
346                 struct {
347                         __le32  l_i_version;
348                 } linux1;
349                 struct {
350                         __u32  h_i_translator;
351                 } hurd1;
352                 struct {
353                         __u32  m_i_reserved1;
354                 } masix1;
355         } osd1;                         /* OS dependent 1 */
356         __le32  i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
357         __le32  i_generation;   /* File version (for NFS) */
358         __le32  i_file_acl_lo;  /* File ACL */
359         __le32  i_size_high;
360         __le32  i_obso_faddr;   /* Obsoleted fragment address */
361         union {
362                 struct {
363                         __le16  l_i_blocks_high; /* were l_i_reserved1 */
364                         __le16  l_i_file_acl_high;
365                         __le16  l_i_uid_high;   /* these 2 fields */
366                         __le16  l_i_gid_high;   /* were reserved2[0] */
367                         __u32   l_i_reserved2;
368                 } linux2;
369                 struct {
370                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
371                         __u16   h_i_mode_high;
372                         __u16   h_i_uid_high;
373                         __u16   h_i_gid_high;
374                         __u32   h_i_author;
375                 } hurd2;
376                 struct {
377                         __le16  h_i_reserved1;  /* Obsoleted fragment number/size which are removed in ext4 */
378                         __le16  m_i_file_acl_high;
379                         __u32   m_i_reserved2[2];
380                 } masix2;
381         } osd2;                         /* OS dependent 2 */
382         __le16  i_extra_isize;
383         __le16  i_pad1;
384         __le32  i_ctime_extra;  /* extra Change time      (nsec << 2 | epoch) */
385         __le32  i_mtime_extra;  /* extra Modification time(nsec << 2 | epoch) */
386         __le32  i_atime_extra;  /* extra Access time      (nsec << 2 | epoch) */
387         __le32  i_crtime;       /* File Creation time */
388         __le32  i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
389         __le32  i_version_hi;   /* high 32 bits for 64-bit version */
390 };
391
392
393 #define EXT4_EPOCH_BITS 2
394 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
395 #define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)
396
397 /*
398  * Extended fields will fit into an inode if the filesystem was formatted
399  * with large inodes (-I 256 or larger) and there are not currently any EAs
400  * consuming all of the available space. For new inodes we always reserve
401  * enough space for the kernel's known extended fields, but for inodes
402  * created with an old kernel this might not have been the case. None of
403  * the extended inode fields is critical for correct filesystem operation.
404  * This macro checks if a certain field fits in the inode. Note that
405  * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
406  */
407 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field)   \
408         ((offsetof(typeof(*ext4_inode), field) +        \
409           sizeof((ext4_inode)->field))                  \
410         <= (EXT4_GOOD_OLD_INODE_SIZE +                  \
411             (einode)->i_extra_isize))                   \
412
413 static inline __le32 ext4_encode_extra_time(struct timespec *time)
414 {
415        return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
416                            time->tv_sec >> 32 : 0) |
417                            ((time->tv_nsec << 2) & EXT4_NSEC_MASK));
418 }
419
420 static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
421 {
422        if (sizeof(time->tv_sec) > 4)
423                time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
424                                << 32;
425        time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> 2;
426 }
427
428 #define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode)                          \
429 do {                                                                           \
430         (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec);               \
431         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
432                 (raw_inode)->xtime ## _extra =                                 \
433                                 ext4_encode_extra_time(&(inode)->xtime);       \
434 } while (0)
435
436 #define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode)                        \
437 do {                                                                           \
438         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
439                 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec);      \
440         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
441                 (raw_inode)->xtime ## _extra =                                 \
442                                 ext4_encode_extra_time(&(einode)->xtime);      \
443 } while (0)
444
445 #define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode)                          \
446 do {                                                                           \
447         (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime);       \
448         if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
449                 ext4_decode_extra_time(&(inode)->xtime,                        \
450                                        raw_inode->xtime ## _extra);            \
451 } while (0)
452
453 #define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode)                        \
454 do {                                                                           \
455         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))                      \
456                 (einode)->xtime.tv_sec =                                       \
457                         (signed)le32_to_cpu((raw_inode)->xtime);               \
458         if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))            \
459                 ext4_decode_extra_time(&(einode)->xtime,                       \
460                                        raw_inode->xtime ## _extra);            \
461 } while (0)
462
463 #define i_disk_version osd1.linux1.l_i_version
464
465 #if defined(__KERNEL__) || defined(__linux__)
466 #define i_reserved1     osd1.linux1.l_i_reserved1
467 #define i_file_acl_high osd2.linux2.l_i_file_acl_high
468 #define i_blocks_high   osd2.linux2.l_i_blocks_high
469 #define i_uid_low       i_uid
470 #define i_gid_low       i_gid
471 #define i_uid_high      osd2.linux2.l_i_uid_high
472 #define i_gid_high      osd2.linux2.l_i_gid_high
473 #define i_reserved2     osd2.linux2.l_i_reserved2
474
475 #elif defined(__GNU__)
476
477 #define i_translator    osd1.hurd1.h_i_translator
478 #define i_uid_high      osd2.hurd2.h_i_uid_high
479 #define i_gid_high      osd2.hurd2.h_i_gid_high
480 #define i_author        osd2.hurd2.h_i_author
481
482 #elif defined(__masix__)
483
484 #define i_reserved1     osd1.masix1.m_i_reserved1
485 #define i_file_acl_high osd2.masix2.m_i_file_acl_high
486 #define i_reserved2     osd2.masix2.m_i_reserved2
487
488 #endif /* defined(__KERNEL__) || defined(__linux__) */
489
490 /*
491  * File system states
492  */
493 #define EXT4_VALID_FS                   0x0001  /* Unmounted cleanly */
494 #define EXT4_ERROR_FS                   0x0002  /* Errors detected */
495 #define EXT4_ORPHAN_FS                  0x0004  /* Orphans being recovered */
496
497 /*
498  * Misc. filesystem flags
499  */
500 #define EXT2_FLAGS_SIGNED_HASH          0x0001  /* Signed dirhash in use */
501 #define EXT2_FLAGS_UNSIGNED_HASH        0x0002  /* Unsigned dirhash in use */
502 #define EXT2_FLAGS_TEST_FILESYS         0x0004  /* to test development code */
503
504 /*
505  * Mount flags
506  */
507 #define EXT4_MOUNT_OLDALLOC             0x00002  /* Don't use the new Orlov allocator */
508 #define EXT4_MOUNT_GRPID                0x00004 /* Create files with directory's group */
509 #define EXT4_MOUNT_DEBUG                0x00008 /* Some debugging messages */
510 #define EXT4_MOUNT_ERRORS_CONT          0x00010 /* Continue on errors */
511 #define EXT4_MOUNT_ERRORS_RO            0x00020 /* Remount fs ro on errors */
512 #define EXT4_MOUNT_ERRORS_PANIC         0x00040 /* Panic on errors */
513 #define EXT4_MOUNT_MINIX_DF             0x00080 /* Mimics the Minix statfs */
514 #define EXT4_MOUNT_NOLOAD               0x00100 /* Don't use existing journal*/
515 #define EXT4_MOUNT_ABORT                0x00200 /* Fatal error detected */
516 #define EXT4_MOUNT_DATA_FLAGS           0x00C00 /* Mode for data writes: */
517 #define EXT4_MOUNT_JOURNAL_DATA         0x00400 /* Write data to journal */
518 #define EXT4_MOUNT_ORDERED_DATA         0x00800 /* Flush data before commit */
519 #define EXT4_MOUNT_WRITEBACK_DATA       0x00C00 /* No data ordering */
520 #define EXT4_MOUNT_UPDATE_JOURNAL       0x01000 /* Update the journal format */
521 #define EXT4_MOUNT_NO_UID32             0x02000  /* Disable 32-bit UIDs */
522 #define EXT4_MOUNT_XATTR_USER           0x04000 /* Extended user attributes */
523 #define EXT4_MOUNT_POSIX_ACL            0x08000 /* POSIX Access Control Lists */
524 #define EXT4_MOUNT_RESERVATION          0x10000 /* Preallocation */
525 #define EXT4_MOUNT_BARRIER              0x20000 /* Use block barriers */
526 #define EXT4_MOUNT_NOBH                 0x40000 /* No bufferheads */
527 #define EXT4_MOUNT_QUOTA                0x80000 /* Some quota option set */
528 #define EXT4_MOUNT_USRQUOTA             0x100000 /* "old" user quota */
529 #define EXT4_MOUNT_GRPQUOTA             0x200000 /* "old" group quota */
530 #define EXT4_MOUNT_JOURNAL_CHECKSUM     0x800000 /* Journal checksums */
531 #define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT 0x1000000 /* Journal Async Commit */
532 #define EXT4_MOUNT_I_VERSION            0x2000000 /* i_version support */
533 #define EXT4_MOUNT_DELALLOC             0x8000000 /* Delalloc support */
534 #define EXT4_MOUNT_DATA_ERR_ABORT       0x10000000 /* Abort on file data write */
535
536 /* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
537 #ifndef _LINUX_EXT2_FS_H
538 #define clear_opt(o, opt)               o &= ~EXT4_MOUNT_##opt
539 #define set_opt(o, opt)                 o |= EXT4_MOUNT_##opt
540 #define test_opt(sb, opt)               (EXT4_SB(sb)->s_mount_opt & \
541                                          EXT4_MOUNT_##opt)
542 #else
543 #define EXT2_MOUNT_NOLOAD               EXT4_MOUNT_NOLOAD
544 #define EXT2_MOUNT_ABORT                EXT4_MOUNT_ABORT
545 #define EXT2_MOUNT_DATA_FLAGS           EXT4_MOUNT_DATA_FLAGS
546 #endif
547
548 #define ext4_set_bit                    ext2_set_bit
549 #define ext4_set_bit_atomic             ext2_set_bit_atomic
550 #define ext4_clear_bit                  ext2_clear_bit
551 #define ext4_clear_bit_atomic           ext2_clear_bit_atomic
552 #define ext4_test_bit                   ext2_test_bit
553 #define ext4_find_first_zero_bit        ext2_find_first_zero_bit
554 #define ext4_find_next_zero_bit         ext2_find_next_zero_bit
555 #define ext4_find_next_bit              ext2_find_next_bit
556
557 /*
558  * Maximal mount counts between two filesystem checks
559  */
560 #define EXT4_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
561 #define EXT4_DFL_CHECKINTERVAL          0       /* Don't use interval check */
562
563 /*
564  * Behaviour when detecting errors
565  */
566 #define EXT4_ERRORS_CONTINUE            1       /* Continue execution */
567 #define EXT4_ERRORS_RO                  2       /* Remount fs read-only */
568 #define EXT4_ERRORS_PANIC               3       /* Panic */
569 #define EXT4_ERRORS_DEFAULT             EXT4_ERRORS_CONTINUE
570
571 /*
572  * Structure of the super block
573  */
574 struct ext4_super_block {
575 /*00*/  __le32  s_inodes_count;         /* Inodes count */
576         __le32  s_blocks_count_lo;      /* Blocks count */
577         __le32  s_r_blocks_count_lo;    /* Reserved blocks count */
578         __le32  s_free_blocks_count_lo; /* Free blocks count */
579 /*10*/  __le32  s_free_inodes_count;    /* Free inodes count */
580         __le32  s_first_data_block;     /* First Data Block */
581         __le32  s_log_block_size;       /* Block size */
582         __le32  s_obso_log_frag_size;   /* Obsoleted fragment size */
583 /*20*/  __le32  s_blocks_per_group;     /* # Blocks per group */
584         __le32  s_obso_frags_per_group; /* Obsoleted fragments per group */
585         __le32  s_inodes_per_group;     /* # Inodes per group */
586         __le32  s_mtime;                /* Mount time */
587 /*30*/  __le32  s_wtime;                /* Write time */
588         __le16  s_mnt_count;            /* Mount count */
589         __le16  s_max_mnt_count;        /* Maximal mount count */
590         __le16  s_magic;                /* Magic signature */
591         __le16  s_state;                /* File system state */
592         __le16  s_errors;               /* Behaviour when detecting errors */
593         __le16  s_minor_rev_level;      /* minor revision level */
594 /*40*/  __le32  s_lastcheck;            /* time of last check */
595         __le32  s_checkinterval;        /* max. time between checks */
596         __le32  s_creator_os;           /* OS */
597         __le32  s_rev_level;            /* Revision level */
598 /*50*/  __le16  s_def_resuid;           /* Default uid for reserved blocks */
599         __le16  s_def_resgid;           /* Default gid for reserved blocks */
600         /*
601          * These fields are for EXT4_DYNAMIC_REV superblocks only.
602          *
603          * Note: the difference between the compatible feature set and
604          * the incompatible feature set is that if there is a bit set
605          * in the incompatible feature set that the kernel doesn't
606          * know about, it should refuse to mount the filesystem.
607          *
608          * e2fsck's requirements are more strict; if it doesn't know
609          * about a feature in either the compatible or incompatible
610          * feature set, it must abort and not try to meddle with
611          * things it doesn't understand...
612          */
613         __le32  s_first_ino;            /* First non-reserved inode */
614         __le16  s_inode_size;           /* size of inode structure */
615         __le16  s_block_group_nr;       /* block group # of this superblock */
616         __le32  s_feature_compat;       /* compatible feature set */
617 /*60*/  __le32  s_feature_incompat;     /* incompatible feature set */
618         __le32  s_feature_ro_compat;    /* readonly-compatible feature set */
619 /*68*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
620 /*78*/  char    s_volume_name[16];      /* volume name */
621 /*88*/  char    s_last_mounted[64];     /* directory where last mounted */
622 /*C8*/  __le32  s_algorithm_usage_bitmap; /* For compression */
623         /*
624          * Performance hints.  Directory preallocation should only
625          * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
626          */
627         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
628         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
629         __le16  s_reserved_gdt_blocks;  /* Per group desc for online growth */
630         /*
631          * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
632          */
633 /*D0*/  __u8    s_journal_uuid[16];     /* uuid of journal superblock */
634 /*E0*/  __le32  s_journal_inum;         /* inode number of journal file */
635         __le32  s_journal_dev;          /* device number of journal file */
636         __le32  s_last_orphan;          /* start of list of inodes to delete */
637         __le32  s_hash_seed[4];         /* HTREE hash seed */
638         __u8    s_def_hash_version;     /* Default hash version to use */
639         __u8    s_reserved_char_pad;
640         __le16  s_desc_size;            /* size of group descriptor */
641 /*100*/ __le32  s_default_mount_opts;
642         __le32  s_first_meta_bg;        /* First metablock block group */
643         __le32  s_mkfs_time;            /* When the filesystem was created */
644         __le32  s_jnl_blocks[17];       /* Backup of the journal inode */
645         /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
646 /*150*/ __le32  s_blocks_count_hi;      /* Blocks count */
647         __le32  s_r_blocks_count_hi;    /* Reserved blocks count */
648         __le32  s_free_blocks_count_hi; /* Free blocks count */
649         __le16  s_min_extra_isize;      /* All inodes have at least # bytes */
650         __le16  s_want_extra_isize;     /* New inodes should reserve # bytes */
651         __le32  s_flags;                /* Miscellaneous flags */
652         __le16  s_raid_stride;          /* RAID stride */
653         __le16  s_mmp_interval;         /* # seconds to wait in MMP checking */
654         __le64  s_mmp_block;            /* Block for multi-mount protection */
655         __le32  s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
656         __u8    s_log_groups_per_flex;  /* FLEX_BG group size */
657         __u8    s_reserved_char_pad2;
658         __le16  s_reserved_pad;
659         __u32   s_reserved[162];        /* Padding to the end of the block */
660 };
661
662 #ifdef __KERNEL__
663 static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
664 {
665         return sb->s_fs_info;
666 }
667 static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
668 {
669         return container_of(inode, struct ext4_inode_info, vfs_inode);
670 }
671
672 static inline struct timespec ext4_current_time(struct inode *inode)
673 {
674         return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
675                 current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
676 }
677
678
679 static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
680 {
681         return ino == EXT4_ROOT_INO ||
682                 ino == EXT4_JOURNAL_INO ||
683                 ino == EXT4_RESIZE_INO ||
684                 (ino >= EXT4_FIRST_INO(sb) &&
685                  ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
686 }
687 #else
688 /* Assume that user mode programs are passing in an ext4fs superblock, not
689  * a kernel struct super_block.  This will allow us to call the feature-test
690  * macros from user land. */
691 #define EXT4_SB(sb)     (sb)
692 #endif
693
694 #define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
695
696 /*
697  * Codes for operating systems
698  */
699 #define EXT4_OS_LINUX           0
700 #define EXT4_OS_HURD            1
701 #define EXT4_OS_MASIX           2
702 #define EXT4_OS_FREEBSD         3
703 #define EXT4_OS_LITES           4
704
705 /*
706  * Revision levels
707  */
708 #define EXT4_GOOD_OLD_REV       0       /* The good old (original) format */
709 #define EXT4_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
710
711 #define EXT4_CURRENT_REV        EXT4_GOOD_OLD_REV
712 #define EXT4_MAX_SUPP_REV       EXT4_DYNAMIC_REV
713
714 #define EXT4_GOOD_OLD_INODE_SIZE 128
715
716 /*
717  * Feature set definitions
718  */
719
720 #define EXT4_HAS_COMPAT_FEATURE(sb,mask)                        \
721         ((EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask)) != 0)
722 #define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask)                     \
723         ((EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask)) != 0)
724 #define EXT4_HAS_INCOMPAT_FEATURE(sb,mask)                      \
725         ((EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask)) != 0)
726 #define EXT4_SET_COMPAT_FEATURE(sb,mask)                        \
727         EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
728 #define EXT4_SET_RO_COMPAT_FEATURE(sb,mask)                     \
729         EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
730 #define EXT4_SET_INCOMPAT_FEATURE(sb,mask)                      \
731         EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
732 #define EXT4_CLEAR_COMPAT_FEATURE(sb,mask)                      \
733         EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
734 #define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask)                   \
735         EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
736 #define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask)                    \
737         EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
738
739 #define EXT4_FEATURE_COMPAT_DIR_PREALLOC        0x0001
740 #define EXT4_FEATURE_COMPAT_IMAGIC_INODES       0x0002
741 #define EXT4_FEATURE_COMPAT_HAS_JOURNAL         0x0004
742 #define EXT4_FEATURE_COMPAT_EXT_ATTR            0x0008
743 #define EXT4_FEATURE_COMPAT_RESIZE_INODE        0x0010
744 #define EXT4_FEATURE_COMPAT_DIR_INDEX           0x0020
745
746 #define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
747 #define EXT4_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
748 #define EXT4_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
749 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
750 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM         0x0010
751 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK        0x0020
752 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE      0x0040
753
754 #define EXT4_FEATURE_INCOMPAT_COMPRESSION       0x0001
755 #define EXT4_FEATURE_INCOMPAT_FILETYPE          0x0002
756 #define EXT4_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
757 #define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
758 #define EXT4_FEATURE_INCOMPAT_META_BG           0x0010
759 #define EXT4_FEATURE_INCOMPAT_EXTENTS           0x0040 /* extents support */
760 #define EXT4_FEATURE_INCOMPAT_64BIT             0x0080
761 #define EXT4_FEATURE_INCOMPAT_MMP               0x0100
762 #define EXT4_FEATURE_INCOMPAT_FLEX_BG           0x0200
763
764 #define EXT4_FEATURE_COMPAT_SUPP        EXT2_FEATURE_COMPAT_EXT_ATTR
765 #define EXT4_FEATURE_INCOMPAT_SUPP      (EXT4_FEATURE_INCOMPAT_FILETYPE| \
766                                          EXT4_FEATURE_INCOMPAT_RECOVER| \
767                                          EXT4_FEATURE_INCOMPAT_META_BG| \
768                                          EXT4_FEATURE_INCOMPAT_EXTENTS| \
769                                          EXT4_FEATURE_INCOMPAT_64BIT| \
770                                          EXT4_FEATURE_INCOMPAT_FLEX_BG)
771 #define EXT4_FEATURE_RO_COMPAT_SUPP     (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
772                                          EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
773                                          EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
774                                          EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
775                                          EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
776                                          EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
777                                          EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
778
779 /*
780  * Default values for user and/or group using reserved blocks
781  */
782 #define EXT4_DEF_RESUID         0
783 #define EXT4_DEF_RESGID         0
784
785 #define EXT4_DEF_INODE_READAHEAD_BLKS   32
786
787 /*
788  * Default mount options
789  */
790 #define EXT4_DEFM_DEBUG         0x0001
791 #define EXT4_DEFM_BSDGROUPS     0x0002
792 #define EXT4_DEFM_XATTR_USER    0x0004
793 #define EXT4_DEFM_ACL           0x0008
794 #define EXT4_DEFM_UID16         0x0010
795 #define EXT4_DEFM_JMODE         0x0060
796 #define EXT4_DEFM_JMODE_DATA    0x0020
797 #define EXT4_DEFM_JMODE_ORDERED 0x0040
798 #define EXT4_DEFM_JMODE_WBACK   0x0060
799
800 /*
801  * Default journal batch times
802  */
803 #define EXT4_DEF_MIN_BATCH_TIME 0
804 #define EXT4_DEF_MAX_BATCH_TIME 15000 /* 15ms */
805
806 /*
807  * Structure of a directory entry
808  */
809 #define EXT4_NAME_LEN 255
810
811 struct ext4_dir_entry {
812         __le32  inode;                  /* Inode number */
813         __le16  rec_len;                /* Directory entry length */
814         __le16  name_len;               /* Name length */
815         char    name[EXT4_NAME_LEN];    /* File name */
816 };
817
818 /*
819  * The new version of the directory entry.  Since EXT4 structures are
820  * stored in intel byte order, and the name_len field could never be
821  * bigger than 255 chars, it's safe to reclaim the extra byte for the
822  * file_type field.
823  */
824 struct ext4_dir_entry_2 {
825         __le32  inode;                  /* Inode number */
826         __le16  rec_len;                /* Directory entry length */
827         __u8    name_len;               /* Name length */
828         __u8    file_type;
829         char    name[EXT4_NAME_LEN];    /* File name */
830 };
831
832 /*
833  * Ext4 directory file types.  Only the low 3 bits are used.  The
834  * other bits are reserved for now.
835  */
836 #define EXT4_FT_UNKNOWN         0
837 #define EXT4_FT_REG_FILE        1
838 #define EXT4_FT_DIR             2
839 #define EXT4_FT_CHRDEV          3
840 #define EXT4_FT_BLKDEV          4
841 #define EXT4_FT_FIFO            5
842 #define EXT4_FT_SOCK            6
843 #define EXT4_FT_SYMLINK         7
844
845 #define EXT4_FT_MAX             8
846
847 /*
848  * EXT4_DIR_PAD defines the directory entries boundaries
849  *
850  * NOTE: It must be a multiple of 4
851  */
852 #define EXT4_DIR_PAD                    4
853 #define EXT4_DIR_ROUND                  (EXT4_DIR_PAD - 1)
854 #define EXT4_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT4_DIR_ROUND) & \
855                                          ~EXT4_DIR_ROUND)
856 #define EXT4_MAX_REC_LEN                ((1<<16)-1)
857
858 /*
859  * Hash Tree Directory indexing
860  * (c) Daniel Phillips, 2001
861  */
862
863 #define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
864                                       EXT4_FEATURE_COMPAT_DIR_INDEX) && \
865                       (EXT4_I(dir)->i_flags & EXT4_INDEX_FL))
866 #define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
867 #define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
868
869 /* Legal values for the dx_root hash_version field: */
870
871 #define DX_HASH_LEGACY          0
872 #define DX_HASH_HALF_MD4        1
873 #define DX_HASH_TEA             2
874 #define DX_HASH_LEGACY_UNSIGNED 3
875 #define DX_HASH_HALF_MD4_UNSIGNED       4
876 #define DX_HASH_TEA_UNSIGNED            5
877
878 #ifdef __KERNEL__
879
880 /* hash info structure used by the directory hash */
881 struct dx_hash_info
882 {
883         u32             hash;
884         u32             minor_hash;
885         int             hash_version;
886         u32             *seed;
887 };
888
889 #define EXT4_HTREE_EOF  0x7fffffff
890
891 /*
892  * Control parameters used by ext4_htree_next_block
893  */
894 #define HASH_NB_ALWAYS          1
895
896
897 /*
898  * Describe an inode's exact location on disk and in memory
899  */
900 struct ext4_iloc
901 {
902         struct buffer_head *bh;
903         unsigned long offset;
904         ext4_group_t block_group;
905 };
906
907 static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
908 {
909         return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
910 }
911
912 /*
913  * This structure is stuffed into the struct file's private_data field
914  * for directories.  It is where we put information so that we can do
915  * readdir operations in hash tree order.
916  */
917 struct dir_private_info {
918         struct rb_root  root;
919         struct rb_node  *curr_node;
920         struct fname    *extra_fname;
921         loff_t          last_pos;
922         __u32           curr_hash;
923         __u32           curr_minor_hash;
924         __u32           next_hash;
925 };
926
927 /* calculate the first block number of the group */
928 static inline ext4_fsblk_t
929 ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
930 {
931         return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
932                 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
933 }
934
935 /*
936  * Special error return code only used by dx_probe() and its callers.
937  */
938 #define ERR_BAD_DX_DIR  -75000
939
940 void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
941                         ext4_group_t *blockgrpp, ext4_grpblk_t *offsetp);
942
943 extern struct proc_dir_entry *ext4_proc_root;
944
945 #ifdef CONFIG_PROC_FS
946 extern const struct file_operations ext4_ui_proc_fops;
947
948 #define EXT4_PROC_HANDLER(name, var)                                    \
949 do {                                                                    \
950         proc = proc_create_data(name, mode, sbi->s_proc,                \
951                                 &ext4_ui_proc_fops, &sbi->s_##var);     \
952         if (proc == NULL) {                                             \
953                 printk(KERN_ERR "EXT4-fs: can't create %s\n", name);    \
954                 goto err_out;                                           \
955         }                                                               \
956 } while (0)
957 #else
958 #define EXT4_PROC_HANDLER(name, var)
959 #endif
960
961 /*
962  * Function prototypes
963  */
964
965 /*
966  * Ok, these declarations are also in <linux/kernel.h> but none of the
967  * ext4 source programs needs to include it so they are duplicated here.
968  */
969 # define NORET_TYPE     /**/
970 # define ATTRIB_NORET   __attribute__((noreturn))
971 # define NORET_AND      noreturn,
972
973 /* bitmap.c */
974 extern unsigned int ext4_count_free(struct buffer_head *, unsigned);
975
976 /* balloc.c */
977 extern unsigned int ext4_block_group(struct super_block *sb,
978                         ext4_fsblk_t blocknr);
979 extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
980                         ext4_fsblk_t blocknr);
981 extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
982 extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
983                         ext4_group_t group);
984 extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
985                         ext4_fsblk_t goal, unsigned long *count, int *errp);
986 extern int ext4_claim_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
987 extern int ext4_has_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
988 extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
989                         ext4_fsblk_t block, unsigned long count, int metadata);
990 extern void ext4_add_groupblocks(handle_t *handle, struct super_block *sb,
991                                 ext4_fsblk_t block, unsigned long count);
992 extern ext4_fsblk_t ext4_count_free_blocks(struct super_block *);
993 extern void ext4_check_blocks_bitmap(struct super_block *);
994 extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
995                                                     ext4_group_t block_group,
996                                                     struct buffer_head ** bh);
997 extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
998
999 /* dir.c */
1000 extern int ext4_check_dir_entry(const char *, struct inode *,
1001                                 struct ext4_dir_entry_2 *,
1002                                 struct buffer_head *, unsigned int);
1003 extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
1004                                     __u32 minor_hash,
1005                                     struct ext4_dir_entry_2 *dirent);
1006 extern void ext4_htree_free_dir_info(struct dir_private_info *p);
1007
1008 /* fsync.c */
1009 extern int ext4_sync_file(struct file *, struct dentry *, int);
1010
1011 /* hash.c */
1012 extern int ext4fs_dirhash(const char *name, int len, struct
1013                           dx_hash_info *hinfo);
1014
1015 /* ialloc.c */
1016 extern struct inode * ext4_new_inode(handle_t *, struct inode *, int);
1017 extern void ext4_free_inode(handle_t *, struct inode *);
1018 extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
1019 extern unsigned long ext4_count_free_inodes(struct super_block *);
1020 extern unsigned long ext4_count_dirs(struct super_block *);
1021 extern void ext4_check_inodes_bitmap(struct super_block *);
1022
1023 /* mballoc.c */
1024 extern long ext4_mb_stats;
1025 extern long ext4_mb_max_to_scan;
1026 extern int ext4_mb_init(struct super_block *, int);
1027 extern int ext4_mb_release(struct super_block *);
1028 extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
1029                                 struct ext4_allocation_request *, int *);
1030 extern int ext4_mb_reserve_blocks(struct super_block *, int);
1031 extern void ext4_discard_preallocations(struct inode *);
1032 extern int __init init_ext4_mballoc(void);
1033 extern void exit_ext4_mballoc(void);
1034 extern void ext4_mb_free_blocks(handle_t *, struct inode *,
1035                 unsigned long, unsigned long, int, unsigned long *);
1036 extern int ext4_mb_add_groupinfo(struct super_block *sb,
1037                 ext4_group_t i, struct ext4_group_desc *desc);
1038 extern void ext4_mb_update_group_info(struct ext4_group_info *grp,
1039                 ext4_grpblk_t add);
1040 extern int ext4_mb_get_buddy_cache_lock(struct super_block *, ext4_group_t);
1041 extern void ext4_mb_put_buddy_cache_lock(struct super_block *,
1042                                                 ext4_group_t, int);
1043 /* inode.c */
1044 int ext4_forget(handle_t *handle, int is_metadata, struct inode *inode,
1045                 struct buffer_head *bh, ext4_fsblk_t blocknr);
1046 struct buffer_head *ext4_getblk(handle_t *, struct inode *,
1047                                                 ext4_lblk_t, int, int *);
1048 struct buffer_head *ext4_bread(handle_t *, struct inode *,
1049                                                 ext4_lblk_t, int, int *);
1050 int ext4_get_block(struct inode *inode, sector_t iblock,
1051                                 struct buffer_head *bh_result, int create);
1052
1053 extern struct inode *ext4_iget(struct super_block *, unsigned long);
1054 extern int  ext4_write_inode(struct inode *, int);
1055 extern int  ext4_setattr(struct dentry *, struct iattr *);
1056 extern int  ext4_getattr(struct vfsmount *mnt, struct dentry *dentry,
1057                                 struct kstat *stat);
1058 extern void ext4_delete_inode(struct inode *);
1059 extern int  ext4_sync_inode(handle_t *, struct inode *);
1060 extern void ext4_dirty_inode(struct inode *);
1061 extern int ext4_change_inode_journal_flag(struct inode *, int);
1062 extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
1063 extern int ext4_can_truncate(struct inode *inode);
1064 extern void ext4_truncate(struct inode *);
1065 extern void ext4_set_inode_flags(struct inode *);
1066 extern void ext4_get_inode_flags(struct ext4_inode_info *);
1067 extern void ext4_set_aops(struct inode *inode);
1068 extern int ext4_writepage_trans_blocks(struct inode *);
1069 extern int ext4_meta_trans_blocks(struct inode *, int nrblocks, int idxblocks);
1070 extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
1071 extern int ext4_block_truncate_page(handle_t *handle,
1072                 struct address_space *mapping, loff_t from);
1073 extern int ext4_page_mkwrite(struct vm_area_struct *vma, struct page *page);
1074 extern qsize_t ext4_get_reserved_space(struct inode *inode);
1075
1076 /* ioctl.c */
1077 extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
1078 extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
1079
1080 /* migrate.c */
1081 extern int ext4_ext_migrate(struct inode *);
1082
1083 /* namei.c */
1084 extern unsigned int ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize);
1085 extern __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize);
1086 extern int ext4_orphan_add(handle_t *, struct inode *);
1087 extern int ext4_orphan_del(handle_t *, struct inode *);
1088 extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
1089                                 __u32 start_minor_hash, __u32 *next_hash);
1090
1091 /* resize.c */
1092 extern int ext4_group_add(struct super_block *sb,
1093                                 struct ext4_new_group_data *input);
1094 extern int ext4_group_extend(struct super_block *sb,
1095                                 struct ext4_super_block *es,
1096                                 ext4_fsblk_t n_blocks_count);
1097
1098 /* super.c */
1099 extern void ext4_error(struct super_block *, const char *, const char *, ...)
1100         __attribute__ ((format (printf, 3, 4)));
1101 extern void __ext4_std_error(struct super_block *, const char *, int);
1102 extern void ext4_abort(struct super_block *, const char *, const char *, ...)
1103         __attribute__ ((format (printf, 3, 4)));
1104 extern void ext4_warning(struct super_block *, const char *, const char *, ...)
1105         __attribute__ ((format (printf, 3, 4)));
1106 extern void ext4_grp_locked_error(struct super_block *, ext4_group_t,
1107                                 const char *, const char *, ...)
1108         __attribute__ ((format (printf, 4, 5)));
1109 extern void ext4_update_dynamic_rev(struct super_block *sb);
1110 extern int ext4_update_compat_feature(handle_t *handle, struct super_block *sb,
1111                                         __u32 compat);
1112 extern int ext4_update_rocompat_feature(handle_t *handle,
1113                                         struct super_block *sb, __u32 rocompat);
1114 extern int ext4_update_incompat_feature(handle_t *handle,
1115                                         struct super_block *sb, __u32 incompat);
1116 extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
1117                                       struct ext4_group_desc *bg);
1118 extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
1119                                       struct ext4_group_desc *bg);
1120 extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
1121                                      struct ext4_group_desc *bg);
1122 extern __u32 ext4_free_blks_count(struct super_block *sb,
1123                                 struct ext4_group_desc *bg);
1124 extern __u32 ext4_free_inodes_count(struct super_block *sb,
1125                                  struct ext4_group_desc *bg);
1126 extern __u32 ext4_used_dirs_count(struct super_block *sb,
1127                                 struct ext4_group_desc *bg);
1128 extern __u32 ext4_itable_unused_count(struct super_block *sb,
1129                                    struct ext4_group_desc *bg);
1130 extern void ext4_block_bitmap_set(struct super_block *sb,
1131                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
1132 extern void ext4_inode_bitmap_set(struct super_block *sb,
1133                                   struct ext4_group_desc *bg, ext4_fsblk_t blk);
1134 extern void ext4_inode_table_set(struct super_block *sb,
1135                                  struct ext4_group_desc *bg, ext4_fsblk_t blk);
1136 extern void ext4_free_blks_set(struct super_block *sb,
1137                                struct ext4_group_desc *bg, __u32 count);
1138 extern void ext4_free_inodes_set(struct super_block *sb,
1139                                 struct ext4_group_desc *bg, __u32 count);
1140 extern void ext4_used_dirs_set(struct super_block *sb,
1141                                 struct ext4_group_desc *bg, __u32 count);
1142 extern void ext4_itable_unused_set(struct super_block *sb,
1143                                    struct ext4_group_desc *bg, __u32 count);
1144
1145 static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
1146 {
1147         return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
1148                 le32_to_cpu(es->s_blocks_count_lo);
1149 }
1150
1151 static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
1152 {
1153         return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
1154                 le32_to_cpu(es->s_r_blocks_count_lo);
1155 }
1156
1157 static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
1158 {
1159         return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
1160                 le32_to_cpu(es->s_free_blocks_count_lo);
1161 }
1162
1163 static inline void ext4_blocks_count_set(struct ext4_super_block *es,
1164                                          ext4_fsblk_t blk)
1165 {
1166         es->s_blocks_count_lo = cpu_to_le32((u32)blk);
1167         es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
1168 }
1169
1170 static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
1171                                               ext4_fsblk_t blk)
1172 {
1173         es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
1174         es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
1175 }
1176
1177 static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
1178                                            ext4_fsblk_t blk)
1179 {
1180         es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
1181         es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
1182 }
1183
1184 static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
1185 {
1186         if (S_ISREG(le16_to_cpu(raw_inode->i_mode)))
1187                 return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
1188                         le32_to_cpu(raw_inode->i_size_lo);
1189         else
1190                 return (loff_t) le32_to_cpu(raw_inode->i_size_lo);
1191 }
1192
1193 static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
1194 {
1195         raw_inode->i_size_lo = cpu_to_le32(i_size);
1196         raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
1197 }
1198
1199 static inline
1200 struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
1201                                             ext4_group_t group)
1202 {
1203          struct ext4_group_info ***grp_info;
1204          long indexv, indexh;
1205          grp_info = EXT4_SB(sb)->s_group_info;
1206          indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
1207          indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
1208          return grp_info[indexv][indexh];
1209 }
1210
1211
1212 static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
1213                                              ext4_group_t block_group)
1214 {
1215         return block_group >> sbi->s_log_groups_per_flex;
1216 }
1217
1218 static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
1219 {
1220         return 1 << sbi->s_log_groups_per_flex;
1221 }
1222
1223 #define ext4_std_error(sb, errno)                               \
1224 do {                                                            \
1225         if ((errno))                                            \
1226                 __ext4_std_error((sb), __func__, (errno));      \
1227 } while (0)
1228
1229 #ifdef CONFIG_SMP
1230 /* Each CPU can accumulate percpu_counter_batch blocks in their local
1231  * counters. So we need to make sure we have free blocks more
1232  * than percpu_counter_batch  * nr_cpu_ids. Also add a window of 4 times.
1233  */
1234 #define EXT4_FREEBLOCKS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
1235 #else
1236 #define EXT4_FREEBLOCKS_WATERMARK 0
1237 #endif
1238
1239 static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
1240 {
1241         /*
1242          * XXX: replace with spinlock if seen contended -bzzz
1243          */
1244         down_write(&EXT4_I(inode)->i_data_sem);
1245         if (newsize > EXT4_I(inode)->i_disksize)
1246                 EXT4_I(inode)->i_disksize = newsize;
1247         up_write(&EXT4_I(inode)->i_data_sem);
1248         return ;
1249 }
1250
1251 struct ext4_group_info {
1252         unsigned long   bb_state;
1253         struct rb_root  bb_free_root;
1254         unsigned short  bb_first_free;
1255         unsigned short  bb_free;
1256         unsigned short  bb_fragments;
1257         struct          list_head bb_prealloc_list;
1258 #ifdef DOUBLE_CHECK
1259         void            *bb_bitmap;
1260 #endif
1261         struct rw_semaphore alloc_sem;
1262         unsigned short  bb_counters[];
1263 };
1264
1265 #define EXT4_GROUP_INFO_NEED_INIT_BIT   0
1266 #define EXT4_GROUP_INFO_LOCKED_BIT      1
1267
1268 #define EXT4_MB_GRP_NEED_INIT(grp)      \
1269         (test_bit(EXT4_GROUP_INFO_NEED_INIT_BIT, &((grp)->bb_state)))
1270
1271 static inline void ext4_lock_group(struct super_block *sb, ext4_group_t group)
1272 {
1273         struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);
1274
1275         bit_spin_lock(EXT4_GROUP_INFO_LOCKED_BIT, &(grinfo->bb_state));
1276 }
1277
1278 static inline void ext4_unlock_group(struct super_block *sb,
1279                                         ext4_group_t group)
1280 {
1281         struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);
1282
1283         bit_spin_unlock(EXT4_GROUP_INFO_LOCKED_BIT, &(grinfo->bb_state));
1284 }
1285
1286 static inline int ext4_is_group_locked(struct super_block *sb,
1287                                         ext4_group_t group)
1288 {
1289         struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);
1290
1291         return bit_spin_is_locked(EXT4_GROUP_INFO_LOCKED_BIT,
1292                                                 &(grinfo->bb_state));
1293 }
1294
1295 /*
1296  * Inodes and files operations
1297  */
1298
1299 /* dir.c */
1300 extern const struct file_operations ext4_dir_operations;
1301
1302 /* file.c */
1303 extern const struct inode_operations ext4_file_inode_operations;
1304 extern const struct file_operations ext4_file_operations;
1305
1306 /* namei.c */
1307 extern const struct inode_operations ext4_dir_inode_operations;
1308 extern const struct inode_operations ext4_special_inode_operations;
1309
1310 /* symlink.c */
1311 extern const struct inode_operations ext4_symlink_inode_operations;
1312 extern const struct inode_operations ext4_fast_symlink_inode_operations;
1313
1314 /* extents.c */
1315 extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
1316 extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1317 extern int ext4_ext_index_trans_blocks(struct inode *inode, int nrblocks,
1318                                        int chunk);
1319 extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
1320                                ext4_lblk_t iblock, unsigned int max_blocks,
1321                                struct buffer_head *bh_result,
1322                                int create, int extend_disksize);
1323 extern void ext4_ext_truncate(struct inode *);
1324 extern void ext4_ext_init(struct super_block *);
1325 extern void ext4_ext_release(struct super_block *);
1326 extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
1327                           loff_t len);
1328 extern int ext4_get_blocks_wrap(handle_t *handle, struct inode *inode,
1329                         sector_t block, unsigned int max_blocks,
1330                         struct buffer_head *bh, int create,
1331                         int extend_disksize, int flag);
1332 extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
1333                         __u64 start, __u64 len);
1334
1335 /*
1336  * Add new method to test wether block and inode bitmaps are properly
1337  * initialized. With uninit_bg reading the block from disk is not enough
1338  * to mark the bitmap uptodate. We need to also zero-out the bitmap
1339  */
1340 #define BH_BITMAP_UPTODATE BH_JBDPrivateStart
1341
1342 static inline int bitmap_uptodate(struct buffer_head *bh)
1343 {
1344         return (buffer_uptodate(bh) &&
1345                         test_bit(BH_BITMAP_UPTODATE, &(bh)->b_state));
1346 }
1347 static inline void set_bitmap_uptodate(struct buffer_head *bh)
1348 {
1349         set_bit(BH_BITMAP_UPTODATE, &(bh)->b_state);
1350 }
1351
1352 #endif  /* __KERNEL__ */
1353
1354 #endif  /* _EXT4_H */