ext4.h 47.8 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
/*
 * Structure of a flex block group info
 */

struct flex_groups {
173 174
	atomic_t free_inodes;
	atomic_t free_blocks;
175
	atomic_t used_dirs;
176 177
};

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

/*
 * Constants relative to the data blocks
 */
206 207 208 209 210
#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)
211 212 213 214

/*
 * Inode flags
 */
215 216 217 218 219 220 221 222
#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 */
223
/* Reserved for compression usage... */
224 225 226 227
#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 */
228
/* End compression flags --- maybe not all used */
229 230 231 232 233 234
#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 已提交
235
#define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
A
Alex Tomas 已提交
236
#define EXT4_EXTENTS_FL			0x00080000 /* Inode uses extents */
237
#define EXT4_EXT_MIGRATE		0x00100000 /* Inode is migrating */
A
Aneesh Kumar K.V 已提交
238
#define EXT4_RESERVED_FL		0x80000000 /* reserved for ext4 lib */
239

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

243 244 245 246 247 248 249
/* 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)

250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
/* 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;
}

267 268 269
/*
 * Inode dynamic state flags
 */
270 271 272
#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 */
273
#define EXT4_STATE_NO_EXPAND		0x00000008 /* No space for expansion */
274
#define EXT4_STATE_DA_ALLOC_CLOSE	0x00000010 /* Alloc DA blks on close */
275 276

/* Used to pass group descriptor data when online resize is done */
277
struct ext4_new_group_input {
D
Dave Kleikamp 已提交
278 279 280 281 282 283
	__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 */
284 285 286
	__u16 unused;
};

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

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

/*
 * ioctl commands
 */
308 309 310 311 312 313
#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
314
#ifdef CONFIG_JBD2_DEBUG
315
#define EXT4_IOC_WAIT_FOR_READONLY	_IOR('f', 99, long)
316
#endif
317 318
#define EXT4_IOC_GETRSVSZ		_IOR('f', 5, long)
#define EXT4_IOC_SETRSVSZ		_IOW('f', 6, long)
T
Theodore Ts'o 已提交
319 320 321
#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)
322
 /* note ioctl 10 reserved for an early version of the FIEMAP ioctl */
T
Theodore Ts'o 已提交
323
 /* note ioctl 11 reserved for filesystem-independent FIEMAP ioctl */
324
#define EXT4_IOC_ALLOC_DA_BLKS		_IO('f', 12)
325 326 327 328

/*
 * ioctl commands in 32 bit emulation
 */
329 330 331 332 333 334 335
#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)
336
#ifdef CONFIG_JBD2_DEBUG
337
#define EXT4_IOC32_WAIT_FOR_READONLY	_IOR('f', 99, int)
338
#endif
339 340
#define EXT4_IOC32_GETVERSION_OLD	FS_IOC32_GETVERSION
#define EXT4_IOC32_SETVERSION_OLD	FS_IOC32_SETVERSION
341 342 343 344 345


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

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


K
Kalpak Shah 已提交
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 487 488 489 490
#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)

491 492
#define i_disk_version osd1.linux1.l_i_version

493 494
#if defined(__KERNEL__) || defined(__linux__)
#define i_reserved1	osd1.linux1.l_i_reserved1
B
Badari Pulavarty 已提交
495
#define i_file_acl_high	osd2.linux2.l_i_file_acl_high
496
#define i_blocks_high	osd2.linux2.l_i_blocks_high
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
#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 已提交
513
#define i_file_acl_high	osd2.masix2.m_i_file_acl_high
514 515 516 517 518 519 520
#define i_reserved2	osd2.masix2.m_i_reserved2

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

/*
 * File system states
 */
521 522 523
#define	EXT4_VALID_FS			0x0001	/* Unmounted cleanly */
#define	EXT4_ERROR_FS			0x0002	/* Errors detected */
#define	EXT4_ORPHAN_FS			0x0004	/* Orphans being recovered */
524

525 526 527 528 529 530 531
/*
 * 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 */

532 533 534
/*
 * Mount flags
 */
535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
#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 */
552
#define EXT4_MOUNT_NO_AUTO_DA_ALLOC	0x10000	/* No auto delalloc mapping */
553 554 555 556 557
#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 */
558 559
#define EXT4_MOUNT_JOURNAL_CHECKSUM	0x800000 /* Journal checksums */
#define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT	0x1000000 /* Journal Async Commit */
560
#define EXT4_MOUNT_I_VERSION            0x2000000 /* i_version support */
561
#define EXT4_MOUNT_DELALLOC		0x8000000 /* Delalloc support */
562 563
#define EXT4_MOUNT_DATA_ERR_ABORT	0x10000000 /* Abort on file data write */

564
/* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
565
#ifndef _LINUX_EXT2_FS_H
566 567 568 569
#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)
570
#else
571 572 573
#define EXT2_MOUNT_NOLOAD		EXT4_MOUNT_NOLOAD
#define EXT2_MOUNT_ABORT		EXT4_MOUNT_ABORT
#define EXT2_MOUNT_DATA_FLAGS		EXT4_MOUNT_DATA_FLAGS
574 575
#endif

576 577 578 579 580 581 582
#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
583
#define ext4_find_next_bit		ext2_find_next_bit
584 585 586 587

/*
 * Maximal mount counts between two filesystem checks
 */
588 589
#define EXT4_DFL_MAX_MNT_COUNT		20	/* Allow 20 mounts */
#define EXT4_DFL_CHECKINTERVAL		0	/* Don't use interval check */
590 591 592 593

/*
 * Behaviour when detecting errors
 */
594 595 596 597
#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
598 599 600 601

/*
 * Structure of the super block
 */
602
struct ext4_super_block {
603
/*00*/	__le32	s_inodes_count;		/* Inodes count */
604
	__le32	s_blocks_count_lo;	/* Blocks count */
605 606
	__le32	s_r_blocks_count_lo;	/* Reserved blocks count */
	__le32	s_free_blocks_count_lo;	/* Free blocks count */
607 608 609
/*10*/	__le32	s_free_inodes_count;	/* Free inodes count */
	__le32	s_first_data_block;	/* First Data Block */
	__le32	s_log_block_size;	/* Block size */
610
	__le32	s_obso_log_frag_size;	/* Obsoleted fragment size */
611
/*20*/	__le32	s_blocks_per_group;	/* # Blocks per group */
612
	__le32	s_obso_frags_per_group;	/* Obsoleted fragments per group */
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
	__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 */
	/*
629
	 * These fields are for EXT4_DYNAMIC_REV superblocks only.
630 631 632 633 634 635 636 637 638 639 640 641
	 *
	 * 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 */
642
	__le16  s_inode_size;		/* size of inode structure */
643 644 645 646 647 648 649 650 651 652
	__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
653
	 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
654 655 656 657 658
	 */
	__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 */
	/*
659
	 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
660 661 662 663 664 665 666 667
	 */
/*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;
668
	__le16  s_desc_size;		/* size of group descriptor */
L
Laurent Vivier 已提交
669
/*100*/	__le32	s_default_mount_opts;
670
	__le32	s_first_meta_bg;	/* First metablock block group */
L
Laurent Vivier 已提交
671 672 673 674 675 676
	__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 已提交
677 678 679 680 681 682 683
	__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)*/
684 685 686
	__u8	s_log_groups_per_flex;  /* FLEX_BG group size */
	__u8	s_reserved_char_pad2;
	__le16  s_reserved_pad;
T
Theodore Ts'o 已提交
687 688
	__le64	s_kbytes_written;	/* nr of lifetime kilobytes written */
	__u32   s_reserved[160];        /* Padding to the end of the block */
689 690 691
};

#ifdef __KERNEL__
692
static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
693 694 695
{
	return sb->s_fs_info;
}
696
static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
697
{
698
	return container_of(inode, struct ext4_inode_info, vfs_inode);
699 700
}

K
Kalpak Shah 已提交
701 702 703 704 705 706 707
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;
}


708
static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
709
{
710 711 712 713 714
	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));
715 716
}
#else
717
/* Assume that user mode programs are passing in an ext4fs superblock, not
718 719
 * a kernel struct super_block.  This will allow us to call the feature-test
 * macros from user land. */
720
#define EXT4_SB(sb)	(sb)
721 722
#endif

723
#define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
724 725 726 727

/*
 * Codes for operating systems
 */
728 729 730 731 732
#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
733 734 735 736

/*
 * Revision levels
 */
737 738
#define EXT4_GOOD_OLD_REV	0	/* The good old (original) format */
#define EXT4_DYNAMIC_REV	1	/* V2 format w/ dynamic inode sizes */
739

740 741
#define EXT4_CURRENT_REV	EXT4_GOOD_OLD_REV
#define EXT4_MAX_SUPP_REV	EXT4_DYNAMIC_REV
742

743
#define EXT4_GOOD_OLD_INODE_SIZE 128
744 745 746 747 748

/*
 * Feature set definitions
 */

749
#define EXT4_HAS_COMPAT_FEATURE(sb,mask)			\
A
Aneesh Kumar K.V 已提交
750
	((EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask)) != 0)
751
#define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask)			\
A
Aneesh Kumar K.V 已提交
752
	((EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask)) != 0)
753
#define EXT4_HAS_INCOMPAT_FEATURE(sb,mask)			\
A
Aneesh Kumar K.V 已提交
754
	((EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask)) != 0)
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
#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
778
#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
A
Andreas Dilger 已提交
779
#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM		0x0010
780
#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK	0x0020
K
Kalpak Shah 已提交
781
#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE	0x0040
782 783 784 785 786 787

#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 已提交
788
#define EXT4_FEATURE_INCOMPAT_EXTENTS		0x0040 /* extents support */
L
Laurent Vivier 已提交
789
#define EXT4_FEATURE_INCOMPAT_64BIT		0x0080
790
#define EXT4_FEATURE_INCOMPAT_MMP               0x0100
J
Jose R. Santos 已提交
791
#define EXT4_FEATURE_INCOMPAT_FLEX_BG		0x0200
792 793 794 795

#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 已提交
796
					 EXT4_FEATURE_INCOMPAT_META_BG| \
L
Laurent Vivier 已提交
797
					 EXT4_FEATURE_INCOMPAT_EXTENTS| \
J
Jose R. Santos 已提交
798 799
					 EXT4_FEATURE_INCOMPAT_64BIT| \
					 EXT4_FEATURE_INCOMPAT_FLEX_BG)
800 801
#define EXT4_FEATURE_RO_COMPAT_SUPP	(EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
					 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
A
Andreas Dilger 已提交
802
					 EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
803
					 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
K
Kalpak Shah 已提交
804
					 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
805 806
					 EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
					 EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
807 808 809 810

/*
 * Default values for user and/or group using reserved blocks
 */
811 812
#define	EXT4_DEF_RESUID		0
#define	EXT4_DEF_RESGID		0
813

814 815
#define EXT4_DEF_INODE_READAHEAD_BLKS	32

816 817 818
/*
 * Default mount options
 */
819 820 821 822 823 824 825 826 827
#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
828

829 830 831 832 833 834
/*
 * Default journal batch times
 */
#define EXT4_DEF_MIN_BATCH_TIME	0
#define EXT4_DEF_MAX_BATCH_TIME	15000 /* 15ms */

835 836 837 838 839 840
/*
 * 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

841 842 843
/*
 * Structure of a directory entry
 */
844
#define EXT4_NAME_LEN 255
845

846
struct ext4_dir_entry {
847 848 849
	__le32	inode;			/* Inode number */
	__le16	rec_len;		/* Directory entry length */
	__le16	name_len;		/* Name length */
850
	char	name[EXT4_NAME_LEN];	/* File name */
851 852 853
};

/*
854
 * The new version of the directory entry.  Since EXT4 structures are
855 856 857 858
 * 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.
 */
859
struct ext4_dir_entry_2 {
860 861 862 863
	__le32	inode;			/* Inode number */
	__le16	rec_len;		/* Directory entry length */
	__u8	name_len;		/* Name length */
	__u8	file_type;
864
	char	name[EXT4_NAME_LEN];	/* File name */
865 866 867
};

/*
868
 * Ext4 directory file types.  Only the low 3 bits are used.  The
869 870
 * other bits are reserved for now.
 */
871 872 873 874 875 876 877 878
#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
879

880
#define EXT4_FT_MAX		8
881 882

/*
883
 * EXT4_DIR_PAD defines the directory entries boundaries
884 885 886
 *
 * NOTE: It must be a multiple of 4
 */
887 888 889 890
#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)
891 892
#define EXT4_MAX_REC_LEN		((1<<16)-1)

893 894 895 896 897
/*
 * Hash Tree Directory indexing
 * (c) Daniel Phillips, 2001
 */

898 899
#define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
				      EXT4_FEATURE_COMPAT_DIR_INDEX) && \
900 901 902
		      (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)
903 904 905 906 907 908

/* 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
909 910 911
#define DX_HASH_LEGACY_UNSIGNED	3
#define DX_HASH_HALF_MD4_UNSIGNED	4
#define DX_HASH_TEA_UNSIGNED		5
912 913 914 915 916 917 918 919 920 921 922 923

#ifdef __KERNEL__

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

924
#define EXT4_HTREE_EOF	0x7fffffff
925 926

/*
927
 * Control parameters used by ext4_htree_next_block
928 929 930 931 932 933 934
 */
#define HASH_NB_ALWAYS		1


/*
 * Describe an inode's exact location on disk and in memory
 */
935
struct ext4_iloc
936 937 938
{
	struct buffer_head *bh;
	unsigned long offset;
939
	ext4_group_t block_group;
940 941
};

942
static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
943
{
944
	return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962
}

/*
 * 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 */
963
static inline ext4_fsblk_t
964
ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
965
{
966 967
	return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
		le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
968 969 970 971 972 973 974
}

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

975
void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
976
			ext4_group_t *blockgrpp, ext4_grpblk_t *offsetp);
977

978 979
extern struct proc_dir_entry *ext4_proc_root;

980 981 982 983 984 985
/*
 * Function prototypes
 */

/*
 * Ok, these declarations are also in <linux/kernel.h> but none of the
986
 * ext4 source programs needs to include it so they are duplicated here.
987
 */
D
Dave Kleikamp 已提交
988 989 990
# define NORET_TYPE	/**/
# define ATTRIB_NORET	__attribute__((noreturn))
# define NORET_AND	noreturn,
991

992 993 994
/* bitmap.c */
extern unsigned int ext4_count_free(struct buffer_head *, unsigned);

995
/* balloc.c */
996 997 998 999
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);
1000 1001 1002
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);
1003
extern ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
1004
			ext4_fsblk_t goal, unsigned long *count, int *errp);
A
Aneesh Kumar K.V 已提交
1005
extern int ext4_claim_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
1006
extern int ext4_has_free_blocks(struct ext4_sb_info *sbi, s64 nblocks);
1007
extern void ext4_free_blocks(handle_t *handle, struct inode *inode,
1008
			ext4_fsblk_t block, unsigned long count, int metadata);
1009 1010
extern void ext4_add_groupblocks(handle_t *handle, struct super_block *sb,
				ext4_fsblk_t block, unsigned long count);
1011 1012
extern ext4_fsblk_t ext4_count_free_blocks(struct super_block *);
extern void ext4_check_blocks_bitmap(struct super_block *);
1013
extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
1014
						    ext4_group_t block_group,
1015
						    struct buffer_head ** bh);
1016
extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
1017 1018

/* dir.c */
1019 1020
extern int ext4_check_dir_entry(const char *, struct inode *,
				struct ext4_dir_entry_2 *,
1021
				struct buffer_head *, unsigned int);
1022
extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
1023
				    __u32 minor_hash,
1024 1025
				    struct ext4_dir_entry_2 *dirent);
extern void ext4_htree_free_dir_info(struct dir_private_info *p);
1026 1027

/* fsync.c */
1028
extern int ext4_sync_file(struct file *, struct dentry *, int);
1029 1030

/* hash.c */
1031
extern int ext4fs_dirhash(const char *name, int len, struct
1032 1033 1034
			  dx_hash_info *hinfo);

/* ialloc.c */
1035 1036 1037 1038 1039 1040
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 *);
1041

1042 1043 1044 1045 1046 1047 1048 1049
/* 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);
1050
extern void ext4_discard_preallocations(struct inode *);
1051 1052 1053 1054
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 *);
1055
extern int ext4_mb_add_groupinfo(struct super_block *sb,
1056 1057 1058
		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);
1059 1060 1061
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);
1062
/* inode.c */
1063 1064
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 已提交
1065 1066 1067 1068
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 *);
1069 1070
int ext4_get_block(struct inode *inode, sector_t iblock,
				struct buffer_head *bh_result, int create);
1071

1072
extern struct inode *ext4_iget(struct super_block *, unsigned long);
1073 1074
extern int  ext4_write_inode(struct inode *, int);
extern int  ext4_setattr(struct dentry *, struct iattr *);
1075 1076
extern int  ext4_getattr(struct vfsmount *mnt, struct dentry *dentry,
				struct kstat *stat);
1077 1078
extern void ext4_delete_inode(struct inode *);
extern int  ext4_sync_inode(handle_t *, struct inode *);
1079 1080 1081
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 *);
1082
extern int ext4_can_truncate(struct inode *inode);
1083
extern void ext4_truncate(struct inode *);
1084
extern void ext4_set_inode_flags(struct inode *);
1085
extern void ext4_get_inode_flags(struct ext4_inode_info *);
1086
extern int ext4_alloc_da_blocks(struct inode *inode);
1087
extern void ext4_set_aops(struct inode *inode);
A
Alex Tomas 已提交
1088
extern int ext4_writepage_trans_blocks(struct inode *);
1089
extern int ext4_meta_trans_blocks(struct inode *, int nrblocks, int idxblocks);
1090
extern int ext4_chunk_trans_blocks(struct inode *, int nrblocks);
1091
extern int ext4_block_truncate_page(handle_t *handle,
A
Alex Tomas 已提交
1092
		struct address_space *mapping, loff_t from);
1093
extern int ext4_page_mkwrite(struct vm_area_struct *vma, struct vm_fault *vmf);
1094
extern qsize_t ext4_get_reserved_space(struct inode *inode);
1095 1096

/* ioctl.c */
A
Andi Kleen 已提交
1097
extern long ext4_ioctl(struct file *, unsigned int, unsigned long);
1098
extern long ext4_compat_ioctl(struct file *, unsigned int, unsigned long);
1099

1100
/* migrate.c */
1101
extern int ext4_ext_migrate(struct inode *);
1102

1103
/* namei.c */
1104 1105
extern unsigned int ext4_rec_len_from_disk(__le16 dlen, unsigned blocksize);
extern __le16 ext4_rec_len_to_disk(unsigned len, unsigned blocksize);
1106 1107 1108
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,
1109 1110 1111
				__u32 start_minor_hash, __u32 *next_hash);

/* resize.c */
1112 1113 1114 1115 1116
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);
1117 1118

/* super.c */
1119
extern void ext4_error(struct super_block *, const char *, const char *, ...)
1120
	__attribute__ ((format (printf, 3, 4)));
1121 1122
extern void __ext4_std_error(struct super_block *, const char *, int);
extern void ext4_abort(struct super_block *, const char *, const char *, ...)
1123
	__attribute__ ((format (printf, 3, 4)));
1124
extern void ext4_warning(struct super_block *, const char *, const char *, ...)
1125
	__attribute__ ((format (printf, 3, 4)));
1126 1127 1128
extern void ext4_grp_locked_error(struct super_block *, ext4_group_t,
				const char *, const char *, ...)
	__attribute__ ((format (printf, 4, 5)));
1129
extern void ext4_update_dynamic_rev(struct super_block *sb);
1130 1131 1132 1133 1134 1135
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);
1136 1137 1138 1139 1140 1141
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);
1142 1143 1144 1145 1146 1147 1148 1149
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);
1150 1151 1152 1153 1154 1155
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);
1156 1157 1158 1159 1160 1161 1162 1163
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 已提交
1164 1165 1166 1167

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) |
1168
		le32_to_cpu(es->s_blocks_count_lo);
L
Laurent Vivier 已提交
1169 1170 1171 1172 1173
}

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) |
1174
		le32_to_cpu(es->s_r_blocks_count_lo);
L
Laurent Vivier 已提交
1175 1176 1177 1178 1179
}

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) |
1180
		le32_to_cpu(es->s_free_blocks_count_lo);
L
Laurent Vivier 已提交
1181 1182 1183 1184 1185
}

static inline void ext4_blocks_count_set(struct ext4_super_block *es,
					 ext4_fsblk_t blk)
{
1186
	es->s_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1187 1188 1189 1190 1191 1192
	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)
{
1193
	es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1194 1195 1196 1197 1198 1199
	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)
{
1200
	es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1201 1202 1203
	es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
}

1204 1205
static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
{
1206 1207 1208 1209 1210
	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);
1211
}
L
Laurent Vivier 已提交
1212

1213 1214 1215 1216 1217
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);
}
1218

1219 1220
static inline
struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
1221
					    ext4_group_t group)
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231
{
	 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];
}


1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242
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;
}

1243
#define ext4_std_error(sb, errno)				\
1244 1245
do {								\
	if ((errno))						\
1246
		__ext4_std_error((sb), __func__, (errno));	\
1247 1248
} while (0)

1249
#ifdef CONFIG_SMP
1250
/* Each CPU can accumulate percpu_counter_batch blocks in their local
1251
 * counters. So we need to make sure we have free blocks more
1252
 * than percpu_counter_batch  * nr_cpu_ids. Also add a window of 4 times.
1253
 */
1254
#define EXT4_FREEBLOCKS_WATERMARK (4 * (percpu_counter_batch * nr_cpu_ids))
1255 1256 1257 1258
#else
#define EXT4_FREEBLOCKS_WATERMARK 0
#endif

1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269
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 ;
}
1270

1271 1272 1273 1274 1275 1276 1277 1278 1279 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
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));
}

1315 1316 1317 1318 1319
/*
 * Inodes and files operations
 */

/* dir.c */
1320
extern const struct file_operations ext4_dir_operations;
1321 1322

/* file.c */
1323
extern const struct inode_operations ext4_file_inode_operations;
1324
extern const struct file_operations ext4_file_operations;
1325 1326

/* namei.c */
1327 1328
extern const struct inode_operations ext4_dir_inode_operations;
extern const struct inode_operations ext4_special_inode_operations;
1329 1330

/* symlink.c */
1331 1332
extern const struct inode_operations ext4_symlink_inode_operations;
extern const struct inode_operations ext4_fast_symlink_inode_operations;
1333

A
Alex Tomas 已提交
1334 1335 1336
/* extents.c */
extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1337 1338
extern int ext4_ext_index_trans_blocks(struct inode *inode, int nrblocks,
				       int chunk);
A
Alex Tomas 已提交
1339
extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
1340 1341 1342
			       ext4_lblk_t iblock, unsigned int max_blocks,
			       struct buffer_head *bh_result,
			       int create, int extend_disksize);
1343
extern void ext4_ext_truncate(struct inode *);
A
Alex Tomas 已提交
1344 1345
extern void ext4_ext_init(struct super_block *);
extern void ext4_ext_release(struct super_block *);
A
Amit Arora 已提交
1346 1347
extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
			  loff_t len);
1348
extern int ext4_get_blocks_wrap(handle_t *handle, struct inode *inode,
1349
			sector_t block, unsigned int max_blocks,
1350
			struct buffer_head *bh, int create,
1351
			int extend_disksize, int flag);
A
Aneesh Kumar K.V 已提交
1352 1353 1354
extern int ext4_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
			__u64 start, __u64 len);

1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
/*
 * 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);
}

1372 1373
#endif	/* __KERNEL__ */

1374
#endif	/* _EXT4_H */