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