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