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