ext4.h 47.9 KB
Newer Older
1
/*
2
 *  ext4.h
3 4 5 6 7 8 9 10 11 12 13 14 15
 *
 * Copyright (C) 1992, 1993, 1994, 1995
 * Remy Card (card@masi.ibp.fr)
 * Laboratoire MASI - Institut Blaise Pascal
 * Universite Pierre et Marie Curie (Paris VI)
 *
 *  from
 *
 *  linux/include/linux/minix_fs.h
 *
 *  Copyright (C) 1991, 1992  Linus Torvalds
 */

16 17
#ifndef _EXT4_H
#define _EXT4_H
18 19

#include <linux/types.h>
20
#include <linux/blkdev.h>
21
#include <linux/magic.h>
22
#include <linux/jbd2.h>
23
#include <linux/quota.h>
24
#include "ext4_i.h"
25

26
/*
S
Shen Feng 已提交
27
 * The fourth extended filesystem constants/structures
28 29 30
 */

/*
31
 * Define EXT4FS_DEBUG to produce debug messages
32
 */
33
#undef EXT4FS_DEBUG
34 35 36 37

/*
 * Debug code
 */
38 39
#ifdef EXT4FS_DEBUG
#define ext4_debug(f, a...)						\
40
	do {								\
41
		printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:",	\
42
			__FILE__, __LINE__, __func__);			\
43
		printk(KERN_DEBUG f, ## a);				\
44 45
	} while (0)
#else
46
#define ext4_debug(f, a...)	do {} while (0)
47 48
#endif

49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68
/* prefer goal again. length */
#define EXT4_MB_HINT_MERGE		1
/* blocks already reserved */
#define EXT4_MB_HINT_RESERVED		2
/* metadata is being allocated */
#define EXT4_MB_HINT_METADATA		4
/* first blocks in the file */
#define EXT4_MB_HINT_FIRST		8
/* search for the best chunk */
#define EXT4_MB_HINT_BEST		16
/* data is being allocated */
#define EXT4_MB_HINT_DATA		32
/* don't preallocate (for tails) */
#define EXT4_MB_HINT_NOPREALLOC		64
/* allocate for locality group */
#define EXT4_MB_HINT_GROUP_ALLOC	128
/* allocate goal blocks or none */
#define EXT4_MB_HINT_GOAL_ONLY		256
/* goal is meaningful */
#define EXT4_MB_HINT_TRY_GOAL		512
69 70 71
/* blocks already pre-reserved by delayed allocation */
#define EXT4_MB_DELALLOC_RESERVED      1024

72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88

struct ext4_allocation_request {
	/* target inode for block we're allocating */
	struct inode *inode;
	/* logical block in target inode */
	ext4_lblk_t logical;
	/* phys. target (a hint) */
	ext4_fsblk_t goal;
	/* the closest logical allocated block to the left */
	ext4_lblk_t lleft;
	/* phys. block for ^^^ */
	ext4_fsblk_t pleft;
	/* the closest logical allocated block to the right */
	ext4_lblk_t lright;
	/* phys. block for ^^^ */
	ext4_fsblk_t pright;
	/* how many blocks we want to allocate */
89
	unsigned int len;
90
	/* flags. see above EXT4_MB_HINT_* */
91
	unsigned int flags;
92 93
};

94 95 96
/*
 * Special inodes numbers
 */
97 98 99 100 101 102
#define	EXT4_BAD_INO		 1	/* Bad blocks inode */
#define EXT4_ROOT_INO		 2	/* Root inode */
#define EXT4_BOOT_LOADER_INO	 5	/* Boot loader inode */
#define EXT4_UNDEL_DIR_INO	 6	/* Undelete directory inode */
#define EXT4_RESIZE_INO		 7	/* Reserved group descriptors inode */
#define EXT4_JOURNAL_INO	 8	/* Journal inode */
103

104 105
/* First non-reserved inode for old ext4 filesystems */
#define EXT4_GOOD_OLD_FIRST_INO	11
106 107 108 109

/*
 * Maximal count of links to a file
 */
110
#define EXT4_LINK_MAX		65000
111 112 113 114

/*
 * Macro-instructions used to manage several block sizes
 */
115
#define EXT4_MIN_BLOCK_SIZE		1024
116 117
#define	EXT4_MAX_BLOCK_SIZE		65536
#define EXT4_MIN_BLOCK_LOG_SIZE		10
118
#ifdef __KERNEL__
119
# define EXT4_BLOCK_SIZE(s)		((s)->s_blocksize)
120
#else
121
# define EXT4_BLOCK_SIZE(s)		(EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
122
#endif
123
#define	EXT4_ADDR_PER_BLOCK(s)		(EXT4_BLOCK_SIZE(s) / sizeof(__u32))
124
#ifdef __KERNEL__
125
# define EXT4_BLOCK_SIZE_BITS(s)	((s)->s_blocksize_bits)
126
#else
127
# define EXT4_BLOCK_SIZE_BITS(s)	((s)->s_log_block_size + 10)
128 129
#endif
#ifdef __KERNEL__
130 131 132
#define	EXT4_ADDR_PER_BLOCK_BITS(s)	(EXT4_SB(s)->s_addr_per_block_bits)
#define EXT4_INODE_SIZE(s)		(EXT4_SB(s)->s_inode_size)
#define EXT4_FIRST_INO(s)		(EXT4_SB(s)->s_first_ino)
133
#else
134 135
#define EXT4_INODE_SIZE(s)	(((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
				 EXT4_GOOD_OLD_INODE_SIZE : \
136
				 (s)->s_inode_size)
137 138
#define EXT4_FIRST_INO(s)	(((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
				 EXT4_GOOD_OLD_FIRST_INO : \
139 140
				 (s)->s_first_ino)
#endif
A
Amit Arora 已提交
141
#define EXT4_BLOCK_ALIGN(size, blkbits)		ALIGN((size), (1 << (blkbits)))
142 143 144 145

/*
 * Structure of a blocks group descriptor
 */
146
struct ext4_group_desc
147
{
148
	__le32	bg_block_bitmap_lo;	/* Blocks bitmap block */
149 150
	__le32	bg_inode_bitmap_lo;	/* Inodes bitmap block */
	__le32	bg_inode_table_lo;	/* Inodes table block */
151 152 153
	__le16	bg_free_blocks_count_lo;/* Free blocks count */
	__le16	bg_free_inodes_count_lo;/* Free inodes count */
	__le16	bg_used_dirs_count_lo;	/* Directories count */
A
Andreas Dilger 已提交
154 155
	__le16	bg_flags;		/* EXT4_BG_flags (INODE_UNINIT, etc) */
	__u32	bg_reserved[2];		/* Likely block/inode bitmap checksum */
156
	__le16  bg_itable_unused_lo;	/* Unused inodes count */
A
Andreas Dilger 已提交
157
	__le16  bg_checksum;		/* crc16(sb_uuid+group+desc) */
158 159 160
	__le32	bg_block_bitmap_hi;	/* Blocks bitmap block MSB */
	__le32	bg_inode_bitmap_hi;	/* Inodes bitmap block MSB */
	__le32	bg_inode_table_hi;	/* Inodes table block MSB */
161 162 163
	__le16	bg_free_blocks_count_hi;/* Free blocks count MSB */
	__le16	bg_free_inodes_count_hi;/* Free inodes count MSB */
	__le16	bg_used_dirs_count_hi;	/* Directories count MSB */
164
	__le16  bg_itable_unused_hi;    /* Unused inodes count MSB */
165
	__u32	bg_reserved2[3];
166 167
};

168 169 170 171 172 173 174 175 176
/*
 * Structure of a flex block group info
 */

struct flex_groups {
	__u32 free_inodes;
	__u32 free_blocks;
};

A
Andreas Dilger 已提交
177 178 179 180
#define EXT4_BG_INODE_UNINIT	0x0001 /* Inode table/bitmap not in use */
#define EXT4_BG_BLOCK_UNINIT	0x0002 /* Block bitmap not in use */
#define EXT4_BG_INODE_ZEROED	0x0004 /* On-disk itable initialized to zero */

L
Laurent Vivier 已提交
181
#ifdef __KERNEL__
182
#include "ext4_sb.h"
L
Laurent Vivier 已提交
183
#endif
184 185 186
/*
 * Macro-instructions used to manage group descriptors
 */
187
#define EXT4_MIN_DESC_SIZE		32
188
#define EXT4_MIN_DESC_SIZE_64BIT	64
189 190
#define	EXT4_MAX_DESC_SIZE		EXT4_MIN_BLOCK_SIZE
#define EXT4_DESC_SIZE(s)		(EXT4_SB(s)->s_desc_size)
191
#ifdef __KERNEL__
192 193 194 195
# define EXT4_BLOCKS_PER_GROUP(s)	(EXT4_SB(s)->s_blocks_per_group)
# define EXT4_DESC_PER_BLOCK(s)		(EXT4_SB(s)->s_desc_per_block)
# define EXT4_INODES_PER_GROUP(s)	(EXT4_SB(s)->s_inodes_per_group)
# define EXT4_DESC_PER_BLOCK_BITS(s)	(EXT4_SB(s)->s_desc_per_block_bits)
196
#else
197
# define EXT4_BLOCKS_PER_GROUP(s)	((s)->s_blocks_per_group)
198
# define EXT4_DESC_PER_BLOCK(s)		(EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
199
# define EXT4_INODES_PER_GROUP(s)	((s)->s_inodes_per_group)
200 201 202 203 204
#endif

/*
 * Constants relative to the data blocks
 */
205 206 207 208 209
#define	EXT4_NDIR_BLOCKS		12
#define	EXT4_IND_BLOCK			EXT4_NDIR_BLOCKS
#define	EXT4_DIND_BLOCK			(EXT4_IND_BLOCK + 1)
#define	EXT4_TIND_BLOCK			(EXT4_DIND_BLOCK + 1)
#define	EXT4_N_BLOCKS			(EXT4_TIND_BLOCK + 1)
210 211 212 213

/*
 * Inode flags
 */
214 215 216 217 218 219 220 221
#define	EXT4_SECRM_FL			0x00000001 /* Secure deletion */
#define	EXT4_UNRM_FL			0x00000002 /* Undelete */
#define	EXT4_COMPR_FL			0x00000004 /* Compress file */
#define EXT4_SYNC_FL			0x00000008 /* Synchronous updates */
#define EXT4_IMMUTABLE_FL		0x00000010 /* Immutable file */
#define EXT4_APPEND_FL			0x00000020 /* writes to file may only append */
#define EXT4_NODUMP_FL			0x00000040 /* do not dump file */
#define EXT4_NOATIME_FL			0x00000080 /* do not update atime */
222
/* Reserved for compression usage... */
223 224 225 226
#define EXT4_DIRTY_FL			0x00000100
#define EXT4_COMPRBLK_FL		0x00000200 /* One or more compressed clusters */
#define EXT4_NOCOMPR_FL			0x00000400 /* Don't compress */
#define EXT4_ECOMPR_FL			0x00000800 /* Compression error */
227
/* End compression flags --- maybe not all used */
228 229 230 231 232 233
#define EXT4_INDEX_FL			0x00001000 /* hash-indexed directory */
#define EXT4_IMAGIC_FL			0x00002000 /* AFS directory */
#define EXT4_JOURNAL_DATA_FL		0x00004000 /* file data should be journaled */
#define EXT4_NOTAIL_FL			0x00008000 /* file tail should not be merged */
#define EXT4_DIRSYNC_FL			0x00010000 /* dirsync behaviour (directories only) */
#define EXT4_TOPDIR_FL			0x00020000 /* Top of directory hierarchies*/
A
Aneesh Kumar K.V 已提交
234
#define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
A
Alex Tomas 已提交
235
#define EXT4_EXTENTS_FL			0x00080000 /* Inode uses extents */
236
#define EXT4_EXT_MIGRATE		0x00100000 /* Inode is migrating */
A
Aneesh Kumar K.V 已提交
237
#define EXT4_RESERVED_FL		0x80000000 /* reserved for ext4 lib */
238

A
Alex Tomas 已提交
239
#define EXT4_FL_USER_VISIBLE		0x000BDFFF /* User visible flags */
240
#define EXT4_FL_USER_MODIFIABLE		0x000B80FF /* User modifiable flags */
241

242 243 244 245 246 247 248
/* Flags that should be inherited by new inodes from their parent. */
#define EXT4_FL_INHERITED (EXT4_SECRM_FL | EXT4_UNRM_FL | EXT4_COMPR_FL |\
			   EXT4_SYNC_FL | EXT4_IMMUTABLE_FL | EXT4_APPEND_FL |\
			   EXT4_NODUMP_FL | EXT4_NOATIME_FL |\
			   EXT4_NOCOMPR_FL | EXT4_JOURNAL_DATA_FL |\
			   EXT4_NOTAIL_FL | EXT4_DIRSYNC_FL)

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
/* Flags that are appropriate for regular files (all but dir-specific ones). */
#define EXT4_REG_FLMASK (~(EXT4_DIRSYNC_FL | EXT4_TOPDIR_FL))

/* Flags that are appropriate for non-directories/regular files. */
#define EXT4_OTHER_FLMASK (EXT4_NODUMP_FL | EXT4_NOATIME_FL)

/* Mask out flags that are inappropriate for the given type of inode. */
static inline __u32 ext4_mask_flags(umode_t mode, __u32 flags)
{
	if (S_ISDIR(mode))
		return flags;
	else if (S_ISREG(mode))
		return flags & EXT4_REG_FLMASK;
	else
		return flags & EXT4_OTHER_FLMASK;
}

266 267 268
/*
 * Inode dynamic state flags
 */
269 270 271
#define EXT4_STATE_JDATA		0x00000001 /* journaled data exists */
#define EXT4_STATE_NEW			0x00000002 /* inode is newly created */
#define EXT4_STATE_XATTR		0x00000004 /* has in-inode xattrs */
272
#define EXT4_STATE_NO_EXPAND		0x00000008 /* No space for expansion */
273 274

/* Used to pass group descriptor data when online resize is done */
275
struct ext4_new_group_input {
D
Dave Kleikamp 已提交
276 277 278 279 280 281
	__u32 group;		/* Group number for this data */
	__u64 block_bitmap;	/* Absolute block number of block bitmap */
	__u64 inode_bitmap;	/* Absolute block number of inode bitmap */
	__u64 inode_table;	/* Absolute block number of inode table start */
	__u32 blocks_count;	/* Total number of blocks in this group */
	__u16 reserved_blocks;	/* Number of reserved blocks in this group */
282 283 284
	__u16 unused;
};

285 286
/* The struct ext4_new_group_input in kernel space, with free_blocks_count */
struct ext4_new_group_data {
287
	__u32 group;
L
Laurent Vivier 已提交
288 289 290
	__u64 block_bitmap;
	__u64 inode_bitmap;
	__u64 inode_table;
291 292 293 294 295 296
	__u32 blocks_count;
	__u16 reserved_blocks;
	__u16 unused;
	__u32 free_blocks_count;
};

A
Amit Arora 已提交
297 298 299 300 301
/*
 * Following is used by preallocation code to tell get_blocks() that we
 * want uninitialzed extents.
 */
#define EXT4_CREATE_UNINITIALIZED_EXT		2
302 303 304 305

/*
 * ioctl commands
 */
306 307 308 309 310 311
#define	EXT4_IOC_GETFLAGS		FS_IOC_GETFLAGS
#define	EXT4_IOC_SETFLAGS		FS_IOC_SETFLAGS
#define	EXT4_IOC_GETVERSION		_IOR('f', 3, long)
#define	EXT4_IOC_SETVERSION		_IOW('f', 4, long)
#define	EXT4_IOC_GETVERSION_OLD		FS_IOC_GETVERSION
#define	EXT4_IOC_SETVERSION_OLD		FS_IOC_SETVERSION
312
#ifdef CONFIG_JBD2_DEBUG
313
#define EXT4_IOC_WAIT_FOR_READONLY	_IOR('f', 99, long)
314
#endif
315 316
#define EXT4_IOC_GETRSVSZ		_IOR('f', 5, long)
#define EXT4_IOC_SETRSVSZ		_IOW('f', 6, long)
T
Theodore Ts'o 已提交
317 318 319 320
#define EXT4_IOC_GROUP_EXTEND		_IOW('f', 7, unsigned long)
#define EXT4_IOC_GROUP_ADD		_IOW('f', 8, struct ext4_new_group_input)
#define EXT4_IOC_MIGRATE		_IO('f', 9)
 /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
321 322 323 324

/*
 * ioctl commands in 32 bit emulation
 */
325 326 327 328 329 330 331
#define EXT4_IOC32_GETFLAGS		FS_IOC32_GETFLAGS
#define EXT4_IOC32_SETFLAGS		FS_IOC32_SETFLAGS
#define EXT4_IOC32_GETVERSION		_IOR('f', 3, int)
#define EXT4_IOC32_SETVERSION		_IOW('f', 4, int)
#define EXT4_IOC32_GETRSVSZ		_IOR('f', 5, int)
#define EXT4_IOC32_SETRSVSZ		_IOW('f', 6, int)
#define EXT4_IOC32_GROUP_EXTEND		_IOW('f', 7, unsigned int)
332
#ifdef CONFIG_JBD2_DEBUG
333
#define EXT4_IOC32_WAIT_FOR_READONLY	_IOR('f', 99, int)
334
#endif
335 336
#define EXT4_IOC32_GETVERSION_OLD	FS_IOC32_GETVERSION
#define EXT4_IOC32_SETVERSION_OLD	FS_IOC32_SETVERSION
337 338 339 340 341


/*
 *  Mount options
 */
342
struct ext4_mount_options {
343 344 345 346
	unsigned long s_mount_opt;
	uid_t s_resuid;
	gid_t s_resgid;
	unsigned long s_commit_interval;
347
	u32 s_min_batch_time, s_max_batch_time;
348 349 350 351 352 353 354 355 356
#ifdef CONFIG_QUOTA
	int s_jquota_fmt;
	char *s_qf_names[MAXQUOTAS];
#endif
};

/*
 * Structure of an inode on the disk
 */
357
struct ext4_inode {
358 359
	__le16	i_mode;		/* File mode */
	__le16	i_uid;		/* Low 16 bits of Owner Uid */
360
	__le32	i_size_lo;	/* Size in bytes */
361
	__le32	i_atime;	/* Access time */
K
Kalpak Shah 已提交
362
	__le32	i_ctime;	/* Inode Change time */
363 364 365 366
	__le32	i_mtime;	/* Modification time */
	__le32	i_dtime;	/* Deletion Time */
	__le16	i_gid;		/* Low 16 bits of Group Id */
	__le16	i_links_count;	/* Links count */
367
	__le32	i_blocks_lo;	/* Blocks count */
368 369 370
	__le32	i_flags;	/* File flags */
	union {
		struct {
371
			__le32  l_i_version;
372 373 374 375 376 377 378 379
		} linux1;
		struct {
			__u32  h_i_translator;
		} hurd1;
		struct {
			__u32  m_i_reserved1;
		} masix1;
	} osd1;				/* OS dependent 1 */
380
	__le32	i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
381
	__le32	i_generation;	/* File version (for NFS) */
382
	__le32	i_file_acl_lo;	/* File ACL */
383
	__le32	i_size_high;
384
	__le32	i_obso_faddr;	/* Obsoleted fragment address */
385 386
	union {
		struct {
387
			__le16	l_i_blocks_high; /* were l_i_reserved1 */
B
Badari Pulavarty 已提交
388
			__le16	l_i_file_acl_high;
D
Dave Kleikamp 已提交
389
			__le16	l_i_uid_high;	/* these 2 fields */
390 391 392 393
			__le16	l_i_gid_high;	/* were reserved2[0] */
			__u32	l_i_reserved2;
		} linux2;
		struct {
394
			__le16	h_i_reserved1;	/* Obsoleted fragment number/size which are removed in ext4 */
395 396 397 398 399 400
			__u16	h_i_mode_high;
			__u16	h_i_uid_high;
			__u16	h_i_gid_high;
			__u32	h_i_author;
		} hurd2;
		struct {
401
			__le16	h_i_reserved1;	/* Obsoleted fragment number/size which are removed in ext4 */
B
Badari Pulavarty 已提交
402
			__le16	m_i_file_acl_high;
403 404 405 406 407
			__u32	m_i_reserved2[2];
		} masix2;
	} osd2;				/* OS dependent 2 */
	__le16	i_extra_isize;
	__le16	i_pad1;
K
Kalpak Shah 已提交
408 409 410 411 412
	__le32  i_ctime_extra;  /* extra Change time      (nsec << 2 | epoch) */
	__le32  i_mtime_extra;  /* extra Modification time(nsec << 2 | epoch) */
	__le32  i_atime_extra;  /* extra Access time      (nsec << 2 | epoch) */
	__le32  i_crtime;       /* File Creation time */
	__le32  i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
413
	__le32  i_version_hi;	/* high 32 bits for 64-bit version */
414 415 416
};


K
Kalpak Shah 已提交
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
#define EXT4_EPOCH_BITS 2
#define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
#define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)

/*
 * Extended fields will fit into an inode if the filesystem was formatted
 * with large inodes (-I 256 or larger) and there are not currently any EAs
 * consuming all of the available space. For new inodes we always reserve
 * enough space for the kernel's known extended fields, but for inodes
 * created with an old kernel this might not have been the case. None of
 * the extended inode fields is critical for correct filesystem operation.
 * This macro checks if a certain field fits in the inode. Note that
 * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
 */
#define EXT4_FITS_IN_INODE(ext4_inode, einode, field)	\
	((offsetof(typeof(*ext4_inode), field) +	\
	  sizeof((ext4_inode)->field))			\
	<= (EXT4_GOOD_OLD_INODE_SIZE +			\
	    (einode)->i_extra_isize))			\

static inline __le32 ext4_encode_extra_time(struct timespec *time)
{
       return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
			   time->tv_sec >> 32 : 0) |
			   ((time->tv_nsec << 2) & EXT4_NSEC_MASK));
}

static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
{
       if (sizeof(time->tv_sec) > 4)
	       time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
			       << 32;
       time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> 2;
}

#define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode)			       \
do {									       \
	(raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec);	       \
	if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
		(raw_inode)->xtime ## _extra =				       \
				ext4_encode_extra_time(&(inode)->xtime);       \
} while (0)

#define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode)			       \
do {									       \
	if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))		       \
		(raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec);      \
	if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))	       \
		(raw_inode)->xtime ## _extra =				       \
				ext4_encode_extra_time(&(einode)->xtime);      \
} while (0)

#define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode)			       \
do {									       \
	(inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime);       \
	if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra))     \
		ext4_decode_extra_time(&(inode)->xtime,			       \
				       raw_inode->xtime ## _extra);	       \
} while (0)

#define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode)			       \
do {									       \
	if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime))		       \
		(einode)->xtime.tv_sec = 				       \
			(signed)le32_to_cpu((raw_inode)->xtime);	       \
	if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra))	       \
		ext4_decode_extra_time(&(einode)->xtime,		       \
				       raw_inode->xtime ## _extra);	       \
} while (0)

487 488
#define i_disk_version osd1.linux1.l_i_version

489 490
#if defined(__KERNEL__) || defined(__linux__)
#define i_reserved1	osd1.linux1.l_i_reserved1
B
Badari Pulavarty 已提交
491
#define i_file_acl_high	osd2.linux2.l_i_file_acl_high
492
#define i_blocks_high	osd2.linux2.l_i_blocks_high
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
#define i_uid_low	i_uid
#define i_gid_low	i_gid
#define i_uid_high	osd2.linux2.l_i_uid_high
#define i_gid_high	osd2.linux2.l_i_gid_high
#define i_reserved2	osd2.linux2.l_i_reserved2

#elif defined(__GNU__)

#define i_translator	osd1.hurd1.h_i_translator
#define i_uid_high	osd2.hurd2.h_i_uid_high
#define i_gid_high	osd2.hurd2.h_i_gid_high
#define i_author	osd2.hurd2.h_i_author

#elif defined(__masix__)

#define i_reserved1	osd1.masix1.m_i_reserved1
B
Badari Pulavarty 已提交
509
#define i_file_acl_high	osd2.masix2.m_i_file_acl_high
510 511 512 513 514 515 516
#define i_reserved2	osd2.masix2.m_i_reserved2

#endif /* defined(__KERNEL__) || defined(__linux__) */

/*
 * File system states
 */
517 518 519
#define	EXT4_VALID_FS			0x0001	/* Unmounted cleanly */
#define	EXT4_ERROR_FS			0x0002	/* Errors detected */
#define	EXT4_ORPHAN_FS			0x0004	/* Orphans being recovered */
520

521 522 523 524 525 526 527
/*
 * Misc. filesystem flags
 */
#define EXT2_FLAGS_SIGNED_HASH		0x0001  /* Signed dirhash in use */
#define EXT2_FLAGS_UNSIGNED_HASH	0x0002  /* Unsigned dirhash in use */
#define EXT2_FLAGS_TEST_FILESYS		0x0004	/* to test development code */

528 529 530
/*
 * Mount flags
 */
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
#define EXT4_MOUNT_OLDALLOC		0x00002  /* Don't use the new Orlov allocator */
#define EXT4_MOUNT_GRPID		0x00004	/* Create files with directory's group */
#define EXT4_MOUNT_DEBUG		0x00008	/* Some debugging messages */
#define EXT4_MOUNT_ERRORS_CONT		0x00010	/* Continue on errors */
#define EXT4_MOUNT_ERRORS_RO		0x00020	/* Remount fs ro on errors */
#define EXT4_MOUNT_ERRORS_PANIC		0x00040	/* Panic on errors */
#define EXT4_MOUNT_MINIX_DF		0x00080	/* Mimics the Minix statfs */
#define EXT4_MOUNT_NOLOAD		0x00100	/* Don't use existing journal*/
#define EXT4_MOUNT_ABORT		0x00200	/* Fatal error detected */
#define EXT4_MOUNT_DATA_FLAGS		0x00C00	/* Mode for data writes: */
#define EXT4_MOUNT_JOURNAL_DATA		0x00400	/* Write data to journal */
#define EXT4_MOUNT_ORDERED_DATA		0x00800	/* Flush data before commit */
#define EXT4_MOUNT_WRITEBACK_DATA	0x00C00	/* No data ordering */
#define EXT4_MOUNT_UPDATE_JOURNAL	0x01000	/* Update the journal format */
#define EXT4_MOUNT_NO_UID32		0x02000  /* Disable 32-bit UIDs */
#define EXT4_MOUNT_XATTR_USER		0x04000	/* Extended user attributes */
#define EXT4_MOUNT_POSIX_ACL		0x08000	/* POSIX Access Control Lists */
#define EXT4_MOUNT_RESERVATION		0x10000	/* Preallocation */
#define EXT4_MOUNT_BARRIER		0x20000 /* Use block barriers */
#define EXT4_MOUNT_NOBH			0x40000 /* No bufferheads */
#define EXT4_MOUNT_QUOTA		0x80000 /* Some quota option set */
#define EXT4_MOUNT_USRQUOTA		0x100000 /* "old" user quota */
#define EXT4_MOUNT_GRPQUOTA		0x200000 /* "old" group quota */
554 555
#define EXT4_MOUNT_JOURNAL_CHECKSUM	0x800000 /* Journal checksums */
#define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT	0x1000000 /* Journal Async Commit */
556
#define EXT4_MOUNT_I_VERSION            0x2000000 /* i_version support */
557
#define EXT4_MOUNT_DELALLOC		0x8000000 /* Delalloc support */
558 559
#define EXT4_MOUNT_DATA_ERR_ABORT	0x10000000 /* Abort on file data write */

560
/* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
561
#ifndef _LINUX_EXT2_FS_H
562 563 564 565
#define clear_opt(o, opt)		o &= ~EXT4_MOUNT_##opt
#define set_opt(o, opt)			o |= EXT4_MOUNT_##opt
#define test_opt(sb, opt)		(EXT4_SB(sb)->s_mount_opt & \
					 EXT4_MOUNT_##opt)
566
#else
567 568 569
#define EXT2_MOUNT_NOLOAD		EXT4_MOUNT_NOLOAD
#define EXT2_MOUNT_ABORT		EXT4_MOUNT_ABORT
#define EXT2_MOUNT_DATA_FLAGS		EXT4_MOUNT_DATA_FLAGS
570 571
#endif

572 573 574 575 576 577 578
#define ext4_set_bit			ext2_set_bit
#define ext4_set_bit_atomic		ext2_set_bit_atomic
#define ext4_clear_bit			ext2_clear_bit
#define ext4_clear_bit_atomic		ext2_clear_bit_atomic
#define ext4_test_bit			ext2_test_bit
#define ext4_find_first_zero_bit	ext2_find_first_zero_bit
#define ext4_find_next_zero_bit		ext2_find_next_zero_bit
579
#define ext4_find_next_bit		ext2_find_next_bit
580 581 582 583

/*
 * Maximal mount counts between two filesystem checks
 */
584 585
#define EXT4_DFL_MAX_MNT_COUNT		20	/* Allow 20 mounts */
#define EXT4_DFL_CHECKINTERVAL		0	/* Don't use interval check */
586 587 588 589

/*
 * Behaviour when detecting errors
 */
590 591 592 593
#define EXT4_ERRORS_CONTINUE		1	/* Continue execution */
#define EXT4_ERRORS_RO			2	/* Remount fs read-only */
#define EXT4_ERRORS_PANIC		3	/* Panic */
#define EXT4_ERRORS_DEFAULT		EXT4_ERRORS_CONTINUE
594 595 596 597

/*
 * Structure of the super block
 */
598
struct ext4_super_block {
599
/*00*/	__le32	s_inodes_count;		/* Inodes count */
600
	__le32	s_blocks_count_lo;	/* Blocks count */
601 602
	__le32	s_r_blocks_count_lo;	/* Reserved blocks count */
	__le32	s_free_blocks_count_lo;	/* Free blocks count */
603 604 605
/*10*/	__le32	s_free_inodes_count;	/* Free inodes count */
	__le32	s_first_data_block;	/* First Data Block */
	__le32	s_log_block_size;	/* Block size */
606
	__le32	s_obso_log_frag_size;	/* Obsoleted fragment size */
607
/*20*/	__le32	s_blocks_per_group;	/* # Blocks per group */
608
	__le32	s_obso_frags_per_group;	/* Obsoleted fragments per group */
609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
	__le32	s_inodes_per_group;	/* # Inodes per group */
	__le32	s_mtime;		/* Mount time */
/*30*/	__le32	s_wtime;		/* Write time */
	__le16	s_mnt_count;		/* Mount count */
	__le16	s_max_mnt_count;	/* Maximal mount count */
	__le16	s_magic;		/* Magic signature */
	__le16	s_state;		/* File system state */
	__le16	s_errors;		/* Behaviour when detecting errors */
	__le16	s_minor_rev_level;	/* minor revision level */
/*40*/	__le32	s_lastcheck;		/* time of last check */
	__le32	s_checkinterval;	/* max. time between checks */
	__le32	s_creator_os;		/* OS */
	__le32	s_rev_level;		/* Revision level */
/*50*/	__le16	s_def_resuid;		/* Default uid for reserved blocks */
	__le16	s_def_resgid;		/* Default gid for reserved blocks */
	/*
625
	 * These fields are for EXT4_DYNAMIC_REV superblocks only.
626 627 628 629 630 631 632 633 634 635 636 637
	 *
	 * Note: the difference between the compatible feature set and
	 * the incompatible feature set is that if there is a bit set
	 * in the incompatible feature set that the kernel doesn't
	 * know about, it should refuse to mount the filesystem.
	 *
	 * e2fsck's requirements are more strict; if it doesn't know
	 * about a feature in either the compatible or incompatible
	 * feature set, it must abort and not try to meddle with
	 * things it doesn't understand...
	 */
	__le32	s_first_ino;		/* First non-reserved inode */
638
	__le16  s_inode_size;		/* size of inode structure */
639 640 641 642 643 644 645 646 647 648
	__le16	s_block_group_nr;	/* block group # of this superblock */
	__le32	s_feature_compat;	/* compatible feature set */
/*60*/	__le32	s_feature_incompat;	/* incompatible feature set */
	__le32	s_feature_ro_compat;	/* readonly-compatible feature set */
/*68*/	__u8	s_uuid[16];		/* 128-bit uuid for volume */
/*78*/	char	s_volume_name[16];	/* volume name */
/*88*/	char	s_last_mounted[64];	/* directory where last mounted */
/*C8*/	__le32	s_algorithm_usage_bitmap; /* For compression */
	/*
	 * Performance hints.  Directory preallocation should only
649
	 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
650 651 652 653 654
	 */
	__u8	s_prealloc_blocks;	/* Nr of blocks to try to preallocate*/
	__u8	s_prealloc_dir_blocks;	/* Nr to preallocate for dirs */
	__le16	s_reserved_gdt_blocks;	/* Per group desc for online growth */
	/*
655
	 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
656 657 658 659 660 661 662 663
	 */
/*D0*/	__u8	s_journal_uuid[16];	/* uuid of journal superblock */
/*E0*/	__le32	s_journal_inum;		/* inode number of journal file */
	__le32	s_journal_dev;		/* device number of journal file */
	__le32	s_last_orphan;		/* start of list of inodes to delete */
	__le32	s_hash_seed[4];		/* HTREE hash seed */
	__u8	s_def_hash_version;	/* Default hash version to use */
	__u8	s_reserved_char_pad;
664
	__le16  s_desc_size;		/* size of group descriptor */
L
Laurent Vivier 已提交
665
/*100*/	__le32	s_default_mount_opts;
666
	__le32	s_first_meta_bg;	/* First metablock block group */
L
Laurent Vivier 已提交
667 668 669 670 671 672
	__le32	s_mkfs_time;		/* When the filesystem was created */
	__le32	s_jnl_blocks[17];	/* Backup of the journal inode */
	/* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
/*150*/	__le32	s_blocks_count_hi;	/* Blocks count */
	__le32	s_r_blocks_count_hi;	/* Reserved blocks count */
	__le32	s_free_blocks_count_hi;	/* Free blocks count */
A
Aneesh Kumar K.V 已提交
673 674 675 676 677 678 679
	__le16	s_min_extra_isize;	/* All inodes have at least # bytes */
	__le16	s_want_extra_isize; 	/* New inodes should reserve # bytes */
	__le32	s_flags;		/* Miscellaneous flags */
	__le16  s_raid_stride;		/* RAID stride */
	__le16  s_mmp_interval;         /* # seconds to wait in MMP checking */
	__le64  s_mmp_block;            /* Block for multi-mount protection */
	__le32  s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
680 681 682 683
	__u8	s_log_groups_per_flex;  /* FLEX_BG group size */
	__u8	s_reserved_char_pad2;
	__le16  s_reserved_pad;
	__u32   s_reserved[162];        /* Padding to the end of the block */
684 685 686
};

#ifdef __KERNEL__
687
static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
688 689 690
{
	return sb->s_fs_info;
}
691
static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
692
{
693
	return container_of(inode, struct ext4_inode_info, vfs_inode);
694 695
}

K
Kalpak Shah 已提交
696 697 698 699 700 701 702
static inline struct timespec ext4_current_time(struct inode *inode)
{
	return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
		current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
}


703
static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
704
{
705 706 707 708 709
	return ino == EXT4_ROOT_INO ||
		ino == EXT4_JOURNAL_INO ||
		ino == EXT4_RESIZE_INO ||
		(ino >= EXT4_FIRST_INO(sb) &&
		 ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
710 711
}
#else
712
/* Assume that user mode programs are passing in an ext4fs superblock, not
713 714
 * a kernel struct super_block.  This will allow us to call the feature-test
 * macros from user land. */
715
#define EXT4_SB(sb)	(sb)
716 717
#endif

718
#define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
719 720 721 722

/*
 * Codes for operating systems
 */
723 724 725 726 727
#define EXT4_OS_LINUX		0
#define EXT4_OS_HURD		1
#define EXT4_OS_MASIX		2
#define EXT4_OS_FREEBSD		3
#define EXT4_OS_LITES		4
728 729 730 731

/*
 * Revision levels
 */
732 733
#define EXT4_GOOD_OLD_REV	0	/* The good old (original) format */
#define EXT4_DYNAMIC_REV	1	/* V2 format w/ dynamic inode sizes */
734

735 736
#define EXT4_CURRENT_REV	EXT4_GOOD_OLD_REV
#define EXT4_MAX_SUPP_REV	EXT4_DYNAMIC_REV
737

738
#define EXT4_GOOD_OLD_INODE_SIZE 128
739 740 741 742 743

/*
 * Feature set definitions
 */

744
#define EXT4_HAS_COMPAT_FEATURE(sb,mask)			\
A
Aneesh Kumar K.V 已提交
745
	((EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask)) != 0)
746
#define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask)			\
A
Aneesh Kumar K.V 已提交
747
	((EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask)) != 0)
748
#define EXT4_HAS_INCOMPAT_FEATURE(sb,mask)			\
A
Aneesh Kumar K.V 已提交
749
	((EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask)) != 0)
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772
#define EXT4_SET_COMPAT_FEATURE(sb,mask)			\
	EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
#define EXT4_SET_RO_COMPAT_FEATURE(sb,mask)			\
	EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
#define EXT4_SET_INCOMPAT_FEATURE(sb,mask)			\
	EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
#define EXT4_CLEAR_COMPAT_FEATURE(sb,mask)			\
	EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
#define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask)			\
	EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
#define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask)			\
	EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)

#define EXT4_FEATURE_COMPAT_DIR_PREALLOC	0x0001
#define EXT4_FEATURE_COMPAT_IMAGIC_INODES	0x0002
#define EXT4_FEATURE_COMPAT_HAS_JOURNAL		0x0004
#define EXT4_FEATURE_COMPAT_EXT_ATTR		0x0008
#define EXT4_FEATURE_COMPAT_RESIZE_INODE	0x0010
#define EXT4_FEATURE_COMPAT_DIR_INDEX		0x0020

#define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER	0x0001
#define EXT4_FEATURE_RO_COMPAT_LARGE_FILE	0x0002
#define EXT4_FEATURE_RO_COMPAT_BTREE_DIR	0x0004
773
#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
A
Andreas Dilger 已提交
774
#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM		0x0010
775
#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK	0x0020
K
Kalpak Shah 已提交
776
#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE	0x0040
777 778 779 780 781 782

#define EXT4_FEATURE_INCOMPAT_COMPRESSION	0x0001
#define EXT4_FEATURE_INCOMPAT_FILETYPE		0x0002
#define EXT4_FEATURE_INCOMPAT_RECOVER		0x0004 /* Needs recovery */
#define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV	0x0008 /* Journal device */
#define EXT4_FEATURE_INCOMPAT_META_BG		0x0010
A
Alex Tomas 已提交
783
#define EXT4_FEATURE_INCOMPAT_EXTENTS		0x0040 /* extents support */
L
Laurent Vivier 已提交
784
#define EXT4_FEATURE_INCOMPAT_64BIT		0x0080
785
#define EXT4_FEATURE_INCOMPAT_MMP               0x0100
J
Jose R. Santos 已提交
786
#define EXT4_FEATURE_INCOMPAT_FLEX_BG		0x0200
787 788 789 790

#define EXT4_FEATURE_COMPAT_SUPP	EXT2_FEATURE_COMPAT_EXT_ATTR
#define EXT4_FEATURE_INCOMPAT_SUPP	(EXT4_FEATURE_INCOMPAT_FILETYPE| \
					 EXT4_FEATURE_INCOMPAT_RECOVER| \
A
Alex Tomas 已提交
791
					 EXT4_FEATURE_INCOMPAT_META_BG| \
L
Laurent Vivier 已提交
792
					 EXT4_FEATURE_INCOMPAT_EXTENTS| \
J
Jose R. Santos 已提交
793 794
					 EXT4_FEATURE_INCOMPAT_64BIT| \
					 EXT4_FEATURE_INCOMPAT_FLEX_BG)
795 796
#define EXT4_FEATURE_RO_COMPAT_SUPP	(EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
					 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
A
Andreas Dilger 已提交
797
					 EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
798
					 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
K
Kalpak Shah 已提交
799
					 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
800 801
					 EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
					 EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
802 803 804 805

/*
 * Default values for user and/or group using reserved blocks
 */
806 807
#define	EXT4_DEF_RESUID		0
#define	EXT4_DEF_RESGID		0
808

809 810
#define EXT4_DEF_INODE_READAHEAD_BLKS	32

811 812 813
/*
 * Default mount options
 */
814 815 816 817 818 819 820 821 822
#define EXT4_DEFM_DEBUG		0x0001
#define EXT4_DEFM_BSDGROUPS	0x0002
#define EXT4_DEFM_XATTR_USER	0x0004
#define EXT4_DEFM_ACL		0x0008
#define EXT4_DEFM_UID16		0x0010
#define EXT4_DEFM_JMODE		0x0060
#define EXT4_DEFM_JMODE_DATA	0x0020
#define EXT4_DEFM_JMODE_ORDERED	0x0040
#define EXT4_DEFM_JMODE_WBACK	0x0060
823

824 825 826 827 828 829
/*
 * Default journal batch times
 */
#define EXT4_DEF_MIN_BATCH_TIME	0
#define EXT4_DEF_MAX_BATCH_TIME	15000 /* 15ms */

830 831 832 833 834 835
/*
 * Minimum number of groups in a flexgroup before we separate out
 * directories into the first block group of a flexgroup
 */
#define EXT4_FLEX_SIZE_DIR_ALLOC_SCHEME	4

836 837 838
/*
 * Structure of a directory entry
 */
839
#define EXT4_NAME_LEN 255
840

841
struct ext4_dir_entry {
842 843 844
	__le32	inode;			/* Inode number */
	__le16	rec_len;		/* Directory entry length */
	__le16	name_len;		/* Name length */
845
	char	name[EXT4_NAME_LEN];	/* File name */
846 847 848
};

/*
849
 * The new version of the directory entry.  Since EXT4 structures are
850 851 852 853
 * stored in intel byte order, and the name_len field could never be
 * bigger than 255 chars, it's safe to reclaim the extra byte for the
 * file_type field.
 */
854
struct ext4_dir_entry_2 {
855 856 857 858
	__le32	inode;			/* Inode number */
	__le16	rec_len;		/* Directory entry length */
	__u8	name_len;		/* Name length */
	__u8	file_type;
859
	char	name[EXT4_NAME_LEN];	/* File name */
860 861 862
};

/*
863
 * Ext4 directory file types.  Only the low 3 bits are used.  The
864 865
 * other bits are reserved for now.
 */
866 867 868 869 870 871 872 873
#define EXT4_FT_UNKNOWN		0
#define EXT4_FT_REG_FILE	1
#define EXT4_FT_DIR		2
#define EXT4_FT_CHRDEV		3
#define EXT4_FT_BLKDEV		4
#define EXT4_FT_FIFO		5
#define EXT4_FT_SOCK		6
#define EXT4_FT_SYMLINK		7
874

875
#define EXT4_FT_MAX		8
876 877

/*
878
 * EXT4_DIR_PAD defines the directory entries boundaries
879 880 881
 *
 * NOTE: It must be a multiple of 4
 */
882 883 884 885
#define EXT4_DIR_PAD			4
#define EXT4_DIR_ROUND			(EXT4_DIR_PAD - 1)
#define EXT4_DIR_REC_LEN(name_len)	(((name_len) + 8 + EXT4_DIR_ROUND) & \
					 ~EXT4_DIR_ROUND)
886 887
#define EXT4_MAX_REC_LEN		((1<<16)-1)

888 889 890 891 892
/*
 * Hash Tree Directory indexing
 * (c) Daniel Phillips, 2001
 */

893 894
#define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
				      EXT4_FEATURE_COMPAT_DIR_INDEX) && \
895 896 897
		      (EXT4_I(dir)->i_flags & EXT4_INDEX_FL))
#define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
#define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
898 899 900 901 902 903

/* Legal values for the dx_root hash_version field: */

#define DX_HASH_LEGACY		0
#define DX_HASH_HALF_MD4	1
#define DX_HASH_TEA		2
904 905 906
#define DX_HASH_LEGACY_UNSIGNED	3
#define DX_HASH_HALF_MD4_UNSIGNED	4
#define DX_HASH_TEA_UNSIGNED		5
907 908 909 910 911 912 913 914 915 916 917 918

#ifdef __KERNEL__

/* hash info structure used by the directory hash */
struct dx_hash_info
{
	u32		hash;
	u32		minor_hash;
	int		hash_version;
	u32		*seed;
};

919
#define EXT4_HTREE_EOF	0x7fffffff
920 921

/*
922
 * Control parameters used by ext4_htree_next_block
923 924 925 926 927 928 929
 */
#define HASH_NB_ALWAYS		1


/*
 * Describe an inode's exact location on disk and in memory
 */
930
struct ext4_iloc
931 932 933
{
	struct buffer_head *bh;
	unsigned long offset;
934
	ext4_group_t block_group;
935 936
};

937
static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
938
{
939
	return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
}

/*
 * This structure is stuffed into the struct file's private_data field
 * for directories.  It is where we put information so that we can do
 * readdir operations in hash tree order.
 */
struct dir_private_info {
	struct rb_root	root;
	struct rb_node	*curr_node;
	struct fname	*extra_fname;
	loff_t		last_pos;
	__u32		curr_hash;
	__u32		curr_minor_hash;
	__u32		next_hash;
};

/* calculate the first block number of the group */
958
static inline ext4_fsblk_t
959
ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
960
{
961 962
	return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
		le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
963 964 965 966 967 968 969
}

/*
 * Special error return code only used by dx_probe() and its callers.
 */
#define ERR_BAD_DX_DIR	-75000

970
void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
971
			ext4_group_t *blockgrpp, ext4_grpblk_t *offsetp);
972

973 974
extern struct proc_dir_entry *ext4_proc_root;

975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990
#ifdef CONFIG_PROC_FS
extern const struct file_operations ext4_ui_proc_fops;

#define	EXT4_PROC_HANDLER(name, var)					\
do {									\
	proc = proc_create_data(name, mode, sbi->s_proc,		\
				&ext4_ui_proc_fops, &sbi->s_##var);	\
	if (proc == NULL) {						\
		printk(KERN_ERR "EXT4-fs: can't create %s\n", name);	\
		goto err_out;						\
	}								\
} while (0)
#else
#define EXT4_PROC_HANDLER(name, var)
#endif

991 992 993 994 995 996
/*
 * Function prototypes
 */

/*
 * Ok, these declarations are also in <linux/kernel.h> but none of the
997
 * ext4 source programs needs to include it so they are duplicated here.
998
 */
D
Dave Kleikamp 已提交
999 1000 1001
# define NORET_TYPE	/**/
# define ATTRIB_NORET	__attribute__((noreturn))
# define NORET_AND	noreturn,
1002

1003 1004 1005
/* bitmap.c */
extern unsigned int ext4_count_free(struct buffer_head *, unsigned);

1006
/* balloc.c */
1007 1008 1009 1010
extern unsigned int ext4_block_group(struct super_block *sb,
			ext4_fsblk_t blocknr);
extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
			ext4_fsblk_t blocknr);
1011 1012 1013
extern int ext4_bg_has_super(struct super_block *sb, ext4_group_t group);
extern unsigned long ext4_bg_num_gdb(struct super_block *sb,
			ext4_group_t group);
1014
extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
1015
			ext4_fsblk_t goal, unsigned long *count, int *errp);
A
Aneesh Kumar K.V 已提交
1016
extern int ext4_claim_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
1017
extern int ext4_has_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
1018
extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
1019
			ext4_fsblk_t block, unsigned long count, int metadata);
1020 1021
extern void ext4_add_groupblocks(handle_t *handle, struct super_block *sb,
				ext4_fsblk_t block, unsigned long count);
1022 1023
extern ext4_fsblk_t ext4_count_free_blocks(struct super_block *);
extern void ext4_check_blocks_bitmap(struct super_block *);
1024
extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
1025
						    ext4_group_t block_group,
1026
						    struct buffer_head ** bh);
1027
extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
1028 1029

/* dir.c */
1030 1031
extern int ext4_check_dir_entry(const char *, struct inode *,
				struct ext4_dir_entry_2 *,
1032
				struct buffer_head *, unsigned int);
1033
extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
1034
				    __u32 minor_hash,
1035 1036
				    struct ext4_dir_entry_2 *dirent);
extern void ext4_htree_free_dir_info(struct dir_private_info *p);
1037 1038

/* fsync.c */
1039
extern int ext4_sync_file(struct file *, struct dentry *, int);
1040 1041

/* hash.c */
1042
extern int ext4fs_dirhash(const char *name, int len, struct
1043 1044 1045
			  dx_hash_info *hinfo);

/* ialloc.c */
1046 1047 1048 1049 1050 1051
extern struct inode * ext4_new_inode(handle_t *, struct inode *, int);
extern void ext4_free_inode(handle_t *, struct inode *);
extern struct inode * ext4_orphan_get(struct super_block *, unsigned long);
extern unsigned long ext4_count_free_inodes(struct super_block *);
extern unsigned long ext4_count_dirs(struct super_block *);
extern void ext4_check_inodes_bitmap(struct super_block *);
1052

1053 1054 1055 1056 1057 1058 1059 1060
/* mballoc.c */
extern long ext4_mb_stats;
extern long ext4_mb_max_to_scan;
extern int ext4_mb_init(struct super_block *, int);
extern int ext4_mb_release(struct super_block *);
extern ext4_fsblk_t ext4_mb_new_blocks(handle_t *,
				struct ext4_allocation_request *, int *);
extern int ext4_mb_reserve_blocks(struct super_block *, int);
1061
extern void ext4_discard_preallocations(struct inode *);
1062 1063 1064 1065
extern int __init init_ext4_mballoc(void);
extern void exit_ext4_mballoc(void);
extern void ext4_mb_free_blocks(handle_t *, struct inode *,
		unsigned long, unsigned long, int, unsigned long *);
1066
extern int ext4_mb_add_groupinfo(struct super_block *sb,
1067 1068 1069
		ext4_group_t i, struct ext4_group_desc *desc);
extern void ext4_mb_update_group_info(struct ext4_group_info *grp,
		ext4_grpblk_t add);
1070 1071 1072
extern int ext4_mb_get_buddy_cache_lock(struct super_block *, ext4_group_t);
extern void ext4_mb_put_buddy_cache_lock(struct super_block *,
						ext4_group_t, int);
1073
/* inode.c */
1074 1075
int ext4_forget(handle_t *handle, int is_metadata, struct inode *inode,
		struct buffer_head *bh, ext4_fsblk_t blocknr);
A
Aneesh Kumar K.V 已提交
1076 1077 1078 1079
struct buffer_head *ext4_getblk(handle_t *, struct inode *,
						ext4_lblk_t, int, int *);
struct buffer_head *ext4_bread(handle_t *, struct inode *,
						ext4_lblk_t, int, int *);
1080 1081
int ext4_get_block(struct inode *inode, sector_t iblock,
				struct buffer_head *bh_result, int create);
1082

1083
extern struct inode *ext4_iget(struct super_block *, unsigned long);
1084 1085
extern int  ext4_write_inode(struct inode *, int);
extern int  ext4_setattr(struct dentry *, struct iattr *);
1086 1087
extern int  ext4_getattr(struct vfsmount *mnt, struct dentry *dentry,
				struct kstat *stat);
1088 1089
extern void ext4_delete_inode(struct inode *);
extern int  ext4_sync_inode(handle_t *, struct inode *);
1090 1091 1092
extern void ext4_dirty_inode(struct inode *);
extern int ext4_change_inode_journal_flag(struct inode *, int);
extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
1093
extern int ext4_can_truncate(struct inode *inode);
1094
extern void ext4_truncate(struct inode *);
1095
extern void ext4_set_inode_flags(struct inode *);
1096
extern void ext4_get_inode_flags(struct ext4_inode_info *);
1097
extern void ext4_set_aops(struct inode *inode);
A
Alex Tomas 已提交
1098
extern int ext4_writepage_trans_blocks(struct inode *);
1099
extern int ext4_meta_trans_blocks(struct inode *, int nrblocks, int idxblocks);
1100
extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
1101
extern int ext4_block_truncate_page(handle_t *handle,
A
Alex Tomas 已提交
1102
		struct address_space *mapping, loff_t from);
1103
extern int ext4_page_mkwrite(struct vm_area_struct *vma, struct page *page);
1104
extern qsize_t ext4_get_reserved_space(struct inode *inode);
1105 1106

/* ioctl.c */
A
Andi Kleen 已提交
1107
extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
1108
extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
1109

1110
/* migrate.c */
1111
extern int ext4_ext_migrate(struct inode *);
1112

1113
/* namei.c */
1114 1115
extern unsigned int ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize);
extern __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize);
1116 1117 1118
extern int ext4_orphan_add(handle_t *, struct inode *);
extern int ext4_orphan_del(handle_t *, struct inode *);
extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
1119 1120 1121
				__u32 start_minor_hash, __u32 *next_hash);

/* resize.c */
1122 1123 1124 1125 1126
extern int ext4_group_add(struct super_block *sb,
				struct ext4_new_group_data *input);
extern int ext4_group_extend(struct super_block *sb,
				struct ext4_super_block *es,
				ext4_fsblk_t n_blocks_count);
1127 1128

/* super.c */
1129
extern void ext4_error(struct super_block *, const char *, const char *, ...)
1130
	__attribute__ ((format (printf, 3, 4)));
1131 1132
extern void __ext4_std_error(struct super_block *, const char *, int);
extern void ext4_abort(struct super_block *, const char *, const char *, ...)
1133
	__attribute__ ((format (printf, 3, 4)));
1134
extern void ext4_warning(struct super_block *, const char *, const char *, ...)
1135
	__attribute__ ((format (printf, 3, 4)));
1136 1137 1138
extern void ext4_grp_locked_error(struct super_block *, ext4_group_t,
				const char *, const char *, ...)
	__attribute__ ((format (printf, 4, 5)));
1139
extern void ext4_update_dynamic_rev(struct super_block *sb);
1140 1141 1142 1143 1144 1145
extern int ext4_update_compat_feature(handle_t *handle, struct super_block *sb,
					__u32 compat);
extern int ext4_update_rocompat_feature(handle_t *handle,
					struct super_block *sb,	__u32 rocompat);
extern int ext4_update_incompat_feature(handle_t *handle,
					struct super_block *sb,	__u32 incompat);
1146 1147 1148 1149 1150 1151
extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
				      struct ext4_group_desc *bg);
extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
				      struct ext4_group_desc *bg);
extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
				     struct ext4_group_desc *bg);
1152 1153 1154 1155 1156 1157 1158 1159
extern __u32 ext4_free_blks_count(struct super_block *sb,
				struct ext4_group_desc *bg);
extern __u32 ext4_free_inodes_count(struct super_block *sb,
				 struct ext4_group_desc *bg);
extern __u32 ext4_used_dirs_count(struct super_block *sb,
				struct ext4_group_desc *bg);
extern __u32 ext4_itable_unused_count(struct super_block *sb,
				   struct ext4_group_desc *bg);
1160 1161 1162 1163 1164 1165
extern void ext4_block_bitmap_set(struct super_block *sb,
				  struct ext4_group_desc *bg, ext4_fsblk_t blk);
extern void ext4_inode_bitmap_set(struct super_block *sb,
				  struct ext4_group_desc *bg, ext4_fsblk_t blk);
extern void ext4_inode_table_set(struct super_block *sb,
				 struct ext4_group_desc *bg, ext4_fsblk_t blk);
1166 1167 1168 1169 1170 1171 1172 1173
extern void ext4_free_blks_set(struct super_block *sb,
			       struct ext4_group_desc *bg, __u32 count);
extern void ext4_free_inodes_set(struct super_block *sb,
				struct ext4_group_desc *bg, __u32 count);
extern void ext4_used_dirs_set(struct super_block *sb,
				struct ext4_group_desc *bg, __u32 count);
extern void ext4_itable_unused_set(struct super_block *sb,
				   struct ext4_group_desc *bg, __u32 count);
L
Laurent Vivier 已提交
1174 1175 1176 1177

static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
{
	return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
1178
		le32_to_cpu(es->s_blocks_count_lo);
L
Laurent Vivier 已提交
1179 1180 1181 1182 1183
}

static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
{
	return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
1184
		le32_to_cpu(es->s_r_blocks_count_lo);
L
Laurent Vivier 已提交
1185 1186 1187 1188 1189
}

static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
{
	return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
1190
		le32_to_cpu(es->s_free_blocks_count_lo);
L
Laurent Vivier 已提交
1191 1192 1193 1194 1195
}

static inline void ext4_blocks_count_set(struct ext4_super_block *es,
					 ext4_fsblk_t blk)
{
1196
	es->s_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1197 1198 1199 1200 1201 1202
	es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
}

static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
					      ext4_fsblk_t blk)
{
1203
	es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1204 1205 1206 1207 1208 1209
	es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
}

static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
					   ext4_fsblk_t blk)
{
1210
	es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1211 1212 1213
	es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
}

1214 1215
static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
{
1216 1217 1218 1219 1220
	if (S_ISREG(le16_to_cpu(raw_inode->i_mode)))
		return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
			le32_to_cpu(raw_inode->i_size_lo);
	else
		return (loff_t) le32_to_cpu(raw_inode->i_size_lo);
1221
}
L
Laurent Vivier 已提交
1222

1223 1224 1225 1226 1227
static inline void ext4_isize_set(struct ext4_inode *raw_inode, loff_t i_size)
{
	raw_inode->i_size_lo = cpu_to_le32(i_size);
	raw_inode->i_size_high = cpu_to_le32(i_size >> 32);
}
1228

1229 1230
static inline
struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
1231
					    ext4_group_t group)
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241
{
	 struct ext4_group_info ***grp_info;
	 long indexv, indexh;
	 grp_info = EXT4_SB(sb)->s_group_info;
	 indexv = group >> (EXT4_DESC_PER_BLOCK_BITS(sb));
	 indexh = group & ((EXT4_DESC_PER_BLOCK(sb)) - 1);
	 return grp_info[indexv][indexh];
}


1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
static inline ext4_group_t ext4_flex_group(struct ext4_sb_info *sbi,
					     ext4_group_t block_group)
{
	return block_group >> sbi->s_log_groups_per_flex;
}

static inline unsigned int ext4_flex_bg_size(struct ext4_sb_info *sbi)
{
	return 1 << sbi->s_log_groups_per_flex;
}

1253
#define ext4_std_error(sb, errno)				\
1254 1255
do {								\
	if ((errno))						\
1256
		__ext4_std_error((sb), __func__, (errno));	\
1257 1258
} while (0)

1259
#ifdef CONFIG_SMP
1260
/* Each CPU can accumulate percpu_counter_batch blocks in their local
1261
 * counters. So we need to make sure we have free blocks more
1262
 * than percpu_counter_batch  * nr_cpu_ids. Also add a window of 4 times.
1263
 */
1264
#define EXT4_FREEBLOCKS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
1265 1266 1267 1268
#else
#define EXT4_FREEBLOCKS_WATERMARK 0
#endif

1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
static inline void ext4_update_i_disksize(struct inode *inode, loff_t newsize)
{
	/*
	 * XXX: replace with spinlock if seen contended -bzzz
	 */
	down_write(&EXT4_I(inode)->i_data_sem);
	if (newsize > EXT4_I(inode)->i_disksize)
		EXT4_I(inode)->i_disksize = newsize;
	up_write(&EXT4_I(inode)->i_data_sem);
	return ;
}
1280

1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324
struct ext4_group_info {
	unsigned long   bb_state;
	struct rb_root  bb_free_root;
	unsigned short  bb_first_free;
	unsigned short  bb_free;
	unsigned short  bb_fragments;
	struct          list_head bb_prealloc_list;
#ifdef DOUBLE_CHECK
	void            *bb_bitmap;
#endif
	struct rw_semaphore alloc_sem;
	unsigned short  bb_counters[];
};

#define EXT4_GROUP_INFO_NEED_INIT_BIT	0
#define EXT4_GROUP_INFO_LOCKED_BIT	1

#define EXT4_MB_GRP_NEED_INIT(grp)	\
	(test_bit(EXT4_GROUP_INFO_NEED_INIT_BIT, &((grp)->bb_state)))

static inline void ext4_lock_group(struct super_block *sb, ext4_group_t group)
{
	struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);

	bit_spin_lock(EXT4_GROUP_INFO_LOCKED_BIT, &(grinfo->bb_state));
}

static inline void ext4_unlock_group(struct super_block *sb,
					ext4_group_t group)
{
	struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);

	bit_spin_unlock(EXT4_GROUP_INFO_LOCKED_BIT, &(grinfo->bb_state));
}

static inline int ext4_is_group_locked(struct super_block *sb,
					ext4_group_t group)
{
	struct ext4_group_info *grinfo = ext4_get_group_info(sb, group);

	return bit_spin_is_locked(EXT4_GROUP_INFO_LOCKED_BIT,
						&(grinfo->bb_state));
}

1325 1326 1327 1328 1329
/*
 * Inodes and files operations
 */

/* dir.c */
1330
extern const struct file_operations ext4_dir_operations;
1331 1332

/* file.c */
1333
extern const struct inode_operations ext4_file_inode_operations;
1334
extern const struct file_operations ext4_file_operations;
1335 1336

/* namei.c */
1337 1338
extern const struct inode_operations ext4_dir_inode_operations;
extern const struct inode_operations ext4_special_inode_operations;
1339 1340

/* symlink.c */
1341 1342
extern const struct inode_operations ext4_symlink_inode_operations;
extern const struct inode_operations ext4_fast_symlink_inode_operations;
1343

A
Alex Tomas 已提交
1344 1345 1346
/* extents.c */
extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1347 1348
extern int ext4_ext_index_trans_blocks(struct inode *inode, int nrblocks,
				       int chunk);
A
Alex Tomas 已提交
1349
extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
1350 1351 1352
			       ext4_lblk_t iblock, unsigned int max_blocks,
			       struct buffer_head *bh_result,
			       int create, int extend_disksize);
1353
extern void ext4_ext_truncate(struct inode *);
A
Alex Tomas 已提交
1354 1355
extern void ext4_ext_init(struct super_block *);
extern void ext4_ext_release(struct super_block *);
A
Amit Arora 已提交
1356 1357
extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
			  loff_t len);
1358
extern int ext4_get_blocks_wrap(handle_t *handle, struct inode *inode,
1359
			sector_t block, unsigned int max_blocks,
1360
			struct buffer_head *bh, int create,
1361
			int extend_disksize, int flag);
A
Aneesh Kumar K.V 已提交
1362 1363 1364
extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
			__u64 start, __u64 len);

1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
/*
 * Add new method to test wether block and inode bitmaps are properly
 * initialized. With uninit_bg reading the block from disk is not enough
 * to mark the bitmap uptodate. We need to also zero-out the bitmap
 */
#define BH_BITMAP_UPTODATE BH_JBDPrivateStart

static inline int bitmap_uptodate(struct buffer_head *bh)
{
	return (buffer_uptodate(bh) &&
			test_bit(BH_BITMAP_UPTODATE, &(bh)->b_state));
}
static inline void set_bitmap_uptodate(struct buffer_head *bh)
{
	set_bit(BH_BITMAP_UPTODATE, &(bh)->b_state);
}

1382 1383
#endif	/* __KERNEL__ */

1384
#endif	/* _EXT4_H */