ext4.h 44.3 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 "ext4_i.h"
23

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

/*
29
 * Define EXT4FS_DEBUG to produce debug messages
30
 */
31
#undef EXT4FS_DEBUG
32 33

/*
34
 * Define EXT4_RESERVATION to reserve data blocks for expanding files
35
 */
D
Dave Kleikamp 已提交
36
#define EXT4_DEFAULT_RESERVE_BLOCKS	8
37
/*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
D
Dave Kleikamp 已提交
38
#define EXT4_MAX_RESERVE_BLOCKS		1027
39
#define EXT4_RESERVE_WINDOW_NOT_ALLOCATED 0
40 41 42 43

/*
 * Debug code
 */
44 45
#ifdef EXT4FS_DEBUG
#define ext4_debug(f, a...)						\
46
	do {								\
47
		printk(KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:",	\
48
			__FILE__, __LINE__, __func__);			\
49
		printk(KERN_DEBUG f, ## a);				\
50 51
	} while (0)
#else
52
#define ext4_debug(f, a...)	do {} while (0)
53 54
#endif

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
#define EXT4_MULTIBLOCK_ALLOCATOR	1

/* 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
77 78 79
/* blocks already pre-reserved by delayed allocation */
#define EXT4_MB_DELALLOC_RESERVED      1024

80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101

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 */
	unsigned long len;
	/* flags. see above EXT4_MB_HINT_* */
	unsigned long flags;
};

102 103 104
/*
 * Special inodes numbers
 */
105 106 107 108 109 110
#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 */
111

112 113
/* First non-reserved inode for old ext4 filesystems */
#define EXT4_GOOD_OLD_FIRST_INO	11
114 115 116 117

/*
 * Maximal count of links to a file
 */
118
#define EXT4_LINK_MAX		65000
119 120 121 122

/*
 * Macro-instructions used to manage several block sizes
 */
123
#define EXT4_MIN_BLOCK_SIZE		1024
124 125
#define	EXT4_MAX_BLOCK_SIZE		65536
#define EXT4_MIN_BLOCK_LOG_SIZE		10
126
#ifdef __KERNEL__
127
# define EXT4_BLOCK_SIZE(s)		((s)->s_blocksize)
128
#else
129
# define EXT4_BLOCK_SIZE(s)		(EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
130
#endif
131
#define	EXT4_ADDR_PER_BLOCK(s)		(EXT4_BLOCK_SIZE(s) / sizeof(__u32))
132
#ifdef __KERNEL__
133
# define EXT4_BLOCK_SIZE_BITS(s)	((s)->s_blocksize_bits)
134
#else
135
# define EXT4_BLOCK_SIZE_BITS(s)	((s)->s_log_block_size + 10)
136 137
#endif
#ifdef __KERNEL__
138 139 140
#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)
141
#else
142 143
#define EXT4_INODE_SIZE(s)	(((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
				 EXT4_GOOD_OLD_INODE_SIZE : \
144
				 (s)->s_inode_size)
145 146
#define EXT4_FIRST_INO(s)	(((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
				 EXT4_GOOD_OLD_FIRST_INO : \
147 148
				 (s)->s_first_ino)
#endif
A
Amit Arora 已提交
149
#define EXT4_BLOCK_ALIGN(size, blkbits)		ALIGN((size), (1 << (blkbits)))
150 151 152 153

/*
 * Structure of a blocks group descriptor
 */
154
struct ext4_group_desc
155
{
156
	__le32	bg_block_bitmap_lo;	/* Blocks bitmap block */
157 158
	__le32	bg_inode_bitmap_lo;	/* Inodes bitmap block */
	__le32	bg_inode_table_lo;	/* Inodes table block */
159 160 161
	__le16	bg_free_blocks_count;	/* Free blocks count */
	__le16	bg_free_inodes_count;	/* Free inodes count */
	__le16	bg_used_dirs_count;	/* Directories count */
A
Andreas Dilger 已提交
162 163 164 165
	__le16	bg_flags;		/* EXT4_BG_flags (INODE_UNINIT, etc) */
	__u32	bg_reserved[2];		/* Likely block/inode bitmap checksum */
	__le16  bg_itable_unused;	/* Unused inodes count */
	__le16  bg_checksum;		/* crc16(sb_uuid+group+desc) */
166 167 168
	__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 */
169 170 171 172 173
	__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 */
	__le16	bg_itable_unused_hi;	/* Unused inodes count MSB */
	__u32	bg_reserved2[3];
174 175
};

176 177 178 179 180 181 182 183 184
/*
 * Structure of a flex block group info
 */

struct flex_groups {
	__u32 free_inodes;
	__u32 free_blocks;
};

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

/*
 * Constants relative to the data blocks
 */
213 214 215 216 217
#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)
218 219 220 221

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

A
Alex Tomas 已提交
247
#define EXT4_FL_USER_VISIBLE		0x000BDFFF /* User visible flags */
248
#define EXT4_FL_USER_MODIFIABLE		0x000B80FF /* User modifiable flags */
249 250 251 252

/*
 * Inode dynamic state flags
 */
253 254 255
#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 */
256
#define EXT4_STATE_NO_EXPAND		0x00000008 /* No space for expansion */
257 258

/* Used to pass group descriptor data when online resize is done */
259
struct ext4_new_group_input {
D
Dave Kleikamp 已提交
260 261 262 263 264 265
	__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 */
266 267 268
	__u16 unused;
};

269 270
/* The struct ext4_new_group_input in kernel space, with free_blocks_count */
struct ext4_new_group_data {
271
	__u32 group;
L
Laurent Vivier 已提交
272 273 274
	__u64 block_bitmap;
	__u64 inode_bitmap;
	__u64 inode_table;
275 276 277 278 279 280
	__u32 blocks_count;
	__u16 reserved_blocks;
	__u16 unused;
	__u32 free_blocks_count;
};

A
Amit Arora 已提交
281 282 283 284 285
/*
 * Following is used by preallocation code to tell get_blocks() that we
 * want uninitialzed extents.
 */
#define EXT4_CREATE_UNINITIALIZED_EXT		2
286 287 288 289

/*
 * ioctl commands
 */
290 291 292 293 294 295
#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
296
#ifdef CONFIG_JBD2_DEBUG
297
#define EXT4_IOC_WAIT_FOR_READONLY	_IOR('f', 99, long)
298
#endif
299 300
#define EXT4_IOC_GETRSVSZ		_IOR('f', 5, long)
#define EXT4_IOC_SETRSVSZ		_IOW('f', 6, long)
T
Theodore Ts'o 已提交
301 302 303 304
#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 */
305 306 307 308

/*
 * ioctl commands in 32 bit emulation
 */
309 310 311 312 313 314 315
#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)
316
#ifdef CONFIG_JBD2_DEBUG
317
#define EXT4_IOC32_WAIT_FOR_READONLY	_IOR('f', 99, int)
318
#endif
319 320
#define EXT4_IOC32_GETVERSION_OLD	FS_IOC32_GETVERSION
#define EXT4_IOC32_SETVERSION_OLD	FS_IOC32_SETVERSION
321 322 323 324 325


/*
 *  Mount options
 */
326
struct ext4_mount_options {
327 328 329 330 331 332 333 334 335 336 337 338 339
	unsigned long s_mount_opt;
	uid_t s_resuid;
	gid_t s_resgid;
	unsigned long s_commit_interval;
#ifdef CONFIG_QUOTA
	int s_jquota_fmt;
	char *s_qf_names[MAXQUOTAS];
#endif
};

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


K
Kalpak Shah 已提交
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 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
#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)

470 471
#define i_disk_version osd1.linux1.l_i_version

472 473
#if defined(__KERNEL__) || defined(__linux__)
#define i_reserved1	osd1.linux1.l_i_reserved1
B
Badari Pulavarty 已提交
474
#define i_file_acl_high	osd2.linux2.l_i_file_acl_high
475
#define i_blocks_high	osd2.linux2.l_i_blocks_high
476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
#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 已提交
492
#define i_file_acl_high	osd2.masix2.m_i_file_acl_high
493 494 495 496 497 498 499
#define i_reserved2	osd2.masix2.m_i_reserved2

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

/*
 * File system states
 */
500 501 502
#define	EXT4_VALID_FS			0x0001	/* Unmounted cleanly */
#define	EXT4_ERROR_FS			0x0002	/* Errors detected */
#define	EXT4_ORPHAN_FS			0x0004	/* Orphans being recovered */
503

504 505 506 507 508 509 510
/*
 * 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 */

511 512 513
/*
 * Mount flags
 */
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536
#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 */
A
Alex Tomas 已提交
537
#define EXT4_MOUNT_EXTENTS		0x400000 /* Extents support */
538 539
#define EXT4_MOUNT_JOURNAL_CHECKSUM	0x800000 /* Journal checksums */
#define EXT4_MOUNT_JOURNAL_ASYNC_COMMIT	0x1000000 /* Journal Async Commit */
540
#define EXT4_MOUNT_I_VERSION            0x2000000 /* i_version support */
541
#define EXT4_MOUNT_DELALLOC		0x8000000 /* Delalloc support */
542 543
#define EXT4_MOUNT_DATA_ERR_ABORT	0x10000000 /* Abort on file data write */

544
/* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
545
#ifndef _LINUX_EXT2_FS_H
546 547 548 549
#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)
550
#else
551 552 553
#define EXT2_MOUNT_NOLOAD		EXT4_MOUNT_NOLOAD
#define EXT2_MOUNT_ABORT		EXT4_MOUNT_ABORT
#define EXT2_MOUNT_DATA_FLAGS		EXT4_MOUNT_DATA_FLAGS
554 555
#endif

556 557 558 559 560 561 562
#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
563
#define ext4_find_next_bit		ext2_find_next_bit
564 565 566 567

/*
 * Maximal mount counts between two filesystem checks
 */
568 569
#define EXT4_DFL_MAX_MNT_COUNT		20	/* Allow 20 mounts */
#define EXT4_DFL_CHECKINTERVAL		0	/* Don't use interval check */
570 571 572 573

/*
 * Behaviour when detecting errors
 */
574 575 576 577
#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
578 579 580 581

/*
 * Structure of the super block
 */
582
struct ext4_super_block {
583
/*00*/	__le32	s_inodes_count;		/* Inodes count */
584
	__le32	s_blocks_count_lo;	/* Blocks count */
585 586
	__le32	s_r_blocks_count_lo;	/* Reserved blocks count */
	__le32	s_free_blocks_count_lo;	/* Free blocks count */
587 588 589
/*10*/	__le32	s_free_inodes_count;	/* Free inodes count */
	__le32	s_first_data_block;	/* First Data Block */
	__le32	s_log_block_size;	/* Block size */
590
	__le32	s_obso_log_frag_size;	/* Obsoleted fragment size */
591
/*20*/	__le32	s_blocks_per_group;	/* # Blocks per group */
592
	__le32	s_obso_frags_per_group;	/* Obsoleted fragments per group */
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
	__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 */
	/*
609
	 * These fields are for EXT4_DYNAMIC_REV superblocks only.
610 611 612 613 614 615 616 617 618 619 620 621
	 *
	 * 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 */
622
	__le16  s_inode_size;		/* size of inode structure */
623 624 625 626 627 628 629 630 631 632
	__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
633
	 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
634 635 636 637 638
	 */
	__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 */
	/*
639
	 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
640 641 642 643 644 645 646 647
	 */
/*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;
648
	__le16  s_desc_size;		/* size of group descriptor */
L
Laurent Vivier 已提交
649
/*100*/	__le32	s_default_mount_opts;
650
	__le32	s_first_meta_bg;	/* First metablock block group */
L
Laurent Vivier 已提交
651 652 653 654 655 656
	__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 已提交
657 658 659 660 661 662 663
	__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)*/
664 665 666 667
	__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 */
668 669 670
};

#ifdef __KERNEL__
671
static inline struct ext4_sb_info *EXT4_SB(struct super_block *sb)
672 673 674
{
	return sb->s_fs_info;
}
675
static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
676
{
677
	return container_of(inode, struct ext4_inode_info, vfs_inode);
678 679
}

K
Kalpak Shah 已提交
680 681 682 683 684 685 686
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;
}


687
static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
688
{
689 690 691 692 693
	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));
694 695
}
#else
696
/* Assume that user mode programs are passing in an ext4fs superblock, not
697 698
 * a kernel struct super_block.  This will allow us to call the feature-test
 * macros from user land. */
699
#define EXT4_SB(sb)	(sb)
700 701
#endif

702
#define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
703 704 705 706

/*
 * Codes for operating systems
 */
707 708 709 710 711
#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
712 713 714 715

/*
 * Revision levels
 */
716 717
#define EXT4_GOOD_OLD_REV	0	/* The good old (original) format */
#define EXT4_DYNAMIC_REV	1	/* V2 format w/ dynamic inode sizes */
718

719 720
#define EXT4_CURRENT_REV	EXT4_GOOD_OLD_REV
#define EXT4_MAX_SUPP_REV	EXT4_DYNAMIC_REV
721

722
#define EXT4_GOOD_OLD_INODE_SIZE 128
723 724 725 726 727

/*
 * Feature set definitions
 */

728
#define EXT4_HAS_COMPAT_FEATURE(sb,mask)			\
729
	(EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask))
730
#define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask)			\
731
	(EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask))
732
#define EXT4_HAS_INCOMPAT_FEATURE(sb,mask)			\
733
	(EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask))
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756
#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
757
#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE        0x0008
A
Andreas Dilger 已提交
758
#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM		0x0010
759
#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK	0x0020
K
Kalpak Shah 已提交
760
#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE	0x0040
761 762 763 764 765 766

#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 已提交
767
#define EXT4_FEATURE_INCOMPAT_EXTENTS		0x0040 /* extents support */
L
Laurent Vivier 已提交
768
#define EXT4_FEATURE_INCOMPAT_64BIT		0x0080
769
#define EXT4_FEATURE_INCOMPAT_MMP               0x0100
J
Jose R. Santos 已提交
770
#define EXT4_FEATURE_INCOMPAT_FLEX_BG		0x0200
771 772 773 774

#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 已提交
775
					 EXT4_FEATURE_INCOMPAT_META_BG| \
L
Laurent Vivier 已提交
776
					 EXT4_FEATURE_INCOMPAT_EXTENTS| \
J
Jose R. Santos 已提交
777 778
					 EXT4_FEATURE_INCOMPAT_64BIT| \
					 EXT4_FEATURE_INCOMPAT_FLEX_BG)
779 780
#define EXT4_FEATURE_RO_COMPAT_SUPP	(EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
					 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
A
Andreas Dilger 已提交
781
					 EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
782
					 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
K
Kalpak Shah 已提交
783
					 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
784 785
					 EXT4_FEATURE_RO_COMPAT_BTREE_DIR |\
					 EXT4_FEATURE_RO_COMPAT_HUGE_FILE)
786 787 788 789

/*
 * Default values for user and/or group using reserved blocks
 */
790 791
#define	EXT4_DEF_RESUID		0
#define	EXT4_DEF_RESGID		0
792

793 794
#define EXT4_DEF_INODE_READAHEAD_BLKS	32

795 796 797
/*
 * Default mount options
 */
798 799 800 801 802 803 804 805 806
#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
807 808 809 810

/*
 * Structure of a directory entry
 */
811
#define EXT4_NAME_LEN 255
812

813
struct ext4_dir_entry {
814 815 816
	__le32	inode;			/* Inode number */
	__le16	rec_len;		/* Directory entry length */
	__le16	name_len;		/* Name length */
817
	char	name[EXT4_NAME_LEN];	/* File name */
818 819 820
};

/*
821
 * The new version of the directory entry.  Since EXT4 structures are
822 823 824 825
 * 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.
 */
826
struct ext4_dir_entry_2 {
827 828 829 830
	__le32	inode;			/* Inode number */
	__le16	rec_len;		/* Directory entry length */
	__u8	name_len;		/* Name length */
	__u8	file_type;
831
	char	name[EXT4_NAME_LEN];	/* File name */
832 833 834
};

/*
835
 * Ext4 directory file types.  Only the low 3 bits are used.  The
836 837
 * other bits are reserved for now.
 */
838 839 840 841 842 843 844 845
#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
846

847
#define EXT4_FT_MAX		8
848 849

/*
850
 * EXT4_DIR_PAD defines the directory entries boundaries
851 852 853
 *
 * NOTE: It must be a multiple of 4
 */
854 855 856 857
#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)
858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877
#define EXT4_MAX_REC_LEN		((1<<16)-1)

static inline unsigned ext4_rec_len_from_disk(__le16 dlen)
{
	unsigned len = le16_to_cpu(dlen);

	if (len == EXT4_MAX_REC_LEN)
		return 1 << 16;
	return len;
}

static inline __le16 ext4_rec_len_to_disk(unsigned len)
{
	if (len == (1 << 16))
		return cpu_to_le16(EXT4_MAX_REC_LEN);
	else if (len > (1 << 16))
		BUG();
	return cpu_to_le16(len);
}

878 879 880 881 882
/*
 * Hash Tree Directory indexing
 * (c) Daniel Phillips, 2001
 */

883 884
#define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
				      EXT4_FEATURE_COMPAT_DIR_INDEX) && \
885 886 887
		      (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)
888 889 890 891 892 893

/* 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
894 895 896
#define DX_HASH_LEGACY_UNSIGNED	3
#define DX_HASH_HALF_MD4_UNSIGNED	4
#define DX_HASH_TEA_UNSIGNED		5
897 898 899 900 901 902 903 904 905 906 907 908

#ifdef __KERNEL__

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

909
#define EXT4_HTREE_EOF	0x7fffffff
910 911

/*
912
 * Control parameters used by ext4_htree_next_block
913 914 915 916 917 918 919
 */
#define HASH_NB_ALWAYS		1


/*
 * Describe an inode's exact location on disk and in memory
 */
920
struct ext4_iloc
921 922 923
{
	struct buffer_head *bh;
	unsigned long offset;
924
	ext4_group_t block_group;
925 926
};

927
static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
928
{
929
	return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
}

/*
 * 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 */
948
static inline ext4_fsblk_t
949
ext4_group_first_block_no(struct super_block *sb, ext4_group_t group_no)
950
{
951 952
	return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
		le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
953 954 955 956 957 958 959
}

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

960 961
void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
			unsigned long *blockgrpp, ext4_grpblk_t *offsetp);
962

963 964
extern struct proc_dir_entry *ext4_proc_root;

965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980
#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

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

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

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

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

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

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

/* ialloc.c */
1034 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 *);
extern unsigned long ext4_count_free(struct buffer_head *, unsigned);
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 1056 1057 1058
extern int ext4_mb_add_more_groupinfo(struct super_block *sb,
		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

/* inode.c */
1062 1063
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 已提交
1064 1065 1066 1067
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 *);
1068 1069
int ext4_get_block(struct inode *inode, sector_t iblock,
				struct buffer_head *bh_result, int create);
1070
int ext4_get_blocks_handle(handle_t *handle, struct inode *inode,
A
Aneesh Kumar K.V 已提交
1071 1072 1073
				ext4_lblk_t iblock, unsigned long maxblocks,
				struct buffer_head *bh_result,
				int create, int extend_disksize);
1074

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

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

1101
/* migrate.c */
1102
extern int ext4_ext_migrate(struct inode *);
1103
/* namei.c */
1104 1105 1106
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,
1107 1108 1109
				__u32 start_minor_hash, __u32 *next_hash);

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

/* super.c */
1117
extern void ext4_error(struct super_block *, const char *, const char *, ...)
1118
	__attribute__ ((format (printf, 3, 4)));
1119 1120
extern void __ext4_std_error(struct super_block *, const char *, int);
extern void ext4_abort(struct super_block *, const char *, const char *, ...)
1121
	__attribute__ ((format (printf, 3, 4)));
1122
extern void ext4_warning(struct super_block *, const char *, const char *, ...)
1123
	__attribute__ ((format (printf, 3, 4)));
1124
extern void ext4_update_dynamic_rev(struct super_block *sb);
1125 1126 1127 1128 1129 1130
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);
1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142
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);
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);
L
Laurent Vivier 已提交
1143 1144 1145 1146

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) |
1147
		le32_to_cpu(es->s_blocks_count_lo);
L
Laurent Vivier 已提交
1148 1149 1150 1151 1152
}

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) |
1153
		le32_to_cpu(es->s_r_blocks_count_lo);
L
Laurent Vivier 已提交
1154 1155 1156 1157 1158
}

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) |
1159
		le32_to_cpu(es->s_free_blocks_count_lo);
L
Laurent Vivier 已提交
1160 1161 1162 1163 1164
}

static inline void ext4_blocks_count_set(struct ext4_super_block *es,
					 ext4_fsblk_t blk)
{
1165
	es->s_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1166 1167 1168 1169 1170 1171
	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)
{
1172
	es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1173 1174 1175 1176 1177 1178
	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)
{
1179
	es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
L
Laurent Vivier 已提交
1180 1181 1182
	es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
}

1183 1184 1185 1186 1187
static inline loff_t ext4_isize(struct ext4_inode *raw_inode)
{
	return ((loff_t)le32_to_cpu(raw_inode->i_size_high) << 32) |
		le32_to_cpu(raw_inode->i_size_lo);
}
L
Laurent Vivier 已提交
1188

1189 1190 1191 1192 1193
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);
}
1194

1195 1196
static inline
struct ext4_group_info *ext4_get_group_info(struct super_block *sb,
1197
					    ext4_group_t group)
1198 1199 1200 1201 1202 1203 1204 1205 1206 1207
{
	 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];
}


1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218
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;
}

1219
#define ext4_std_error(sb, errno)				\
1220 1221
do {								\
	if ((errno))						\
1222
		__ext4_std_error((sb), __func__, (errno));	\
1223 1224
} while (0)

1225 1226 1227 1228 1229 1230 1231 1232 1233 1234
#ifdef CONFIG_SMP
/* Each CPU can accumulate FBC_BATCH blocks in their local
 * counters. So we need to make sure we have free blocks more
 * than FBC_BATCH  * nr_cpu_ids. Also add a window of 4 times.
 */
#define EXT4_FREEBLOCKS_WATERMARK (4 * (FBC_BATCH * nr_cpu_ids))
#else
#define EXT4_FREEBLOCKS_WATERMARK 0
#endif

1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245
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 ;
}
1246

1247 1248 1249 1250 1251
/*
 * Inodes and files operations
 */

/* dir.c */
1252
extern const struct file_operations ext4_dir_operations;
1253 1254

/* file.c */
1255
extern const struct inode_operations ext4_file_inode_operations;
1256
extern const struct file_operations ext4_file_operations;
1257 1258

/* namei.c */
1259 1260
extern const struct inode_operations ext4_dir_inode_operations;
extern const struct inode_operations ext4_special_inode_operations;
1261 1262

/* symlink.c */
1263 1264
extern const struct inode_operations ext4_symlink_inode_operations;
extern const struct inode_operations ext4_fast_symlink_inode_operations;
1265

A
Alex Tomas 已提交
1266 1267 1268
/* extents.c */
extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1269 1270
extern int ext4_ext_index_trans_blocks(struct inode *inode, int nrblocks,
				       int chunk);
A
Alex Tomas 已提交
1271
extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
A
Aneesh Kumar K.V 已提交
1272
			ext4_lblk_t iblock,
A
Alex Tomas 已提交
1273 1274
			unsigned long max_blocks, struct buffer_head *bh_result,
			int create, int extend_disksize);
1275
extern void ext4_ext_truncate(struct inode *);
A
Alex Tomas 已提交
1276 1277
extern void ext4_ext_init(struct super_block *);
extern void ext4_ext_release(struct super_block *);
A
Amit Arora 已提交
1278 1279
extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
			  loff_t len);
1280 1281 1282
extern int ext4_get_blocks_wrap(handle_t *handle, struct inode *inode,
			sector_t block, unsigned long max_blocks,
			struct buffer_head *bh, int create,
1283
			int extend_disksize, int flag);
1284 1285
#endif	/* __KERNEL__ */

1286
#endif	/* _EXT4_H */