2 * linux/include/linux/ext4_fs.h
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)
11 * linux/include/linux/minix_fs.h
13 * Copyright (C) 1991, 1992 Linus Torvalds
16 #ifndef _LINUX_EXT4_FS_H
17 #define _LINUX_EXT4_FS_H
19 #include <linux/types.h>
20 #include <linux/blkdev.h>
21 #include <linux/magic.h>
24 * The second extended filesystem constants/structures
28 * Define EXT4FS_DEBUG to produce debug messages
33 * Define EXT4_RESERVATION to reserve data blocks for expanding files
35 #define EXT4_DEFAULT_RESERVE_BLOCKS 8
36 /*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
37 #define EXT4_MAX_RESERVE_BLOCKS 1027
38 #define EXT4_RESERVE_WINDOW_NOT_ALLOCATED 0
44 #define ext4_debug(f, a...) \
46 printk (KERN_DEBUG "EXT4-fs DEBUG (%s, %d): %s:", \
47 __FILE__, __LINE__, __FUNCTION__); \
48 printk (KERN_DEBUG f, ## a); \
51 #define ext4_debug(f, a...) do {} while (0)
55 * Special inodes numbers
57 #define EXT4_BAD_INO 1 /* Bad blocks inode */
58 #define EXT4_ROOT_INO 2 /* Root inode */
59 #define EXT4_BOOT_LOADER_INO 5 /* Boot loader inode */
60 #define EXT4_UNDEL_DIR_INO 6 /* Undelete directory inode */
61 #define EXT4_RESIZE_INO 7 /* Reserved group descriptors inode */
62 #define EXT4_JOURNAL_INO 8 /* Journal inode */
64 /* First non-reserved inode for old ext4 filesystems */
65 #define EXT4_GOOD_OLD_FIRST_INO 11
68 * Maximal count of links to a file
70 #define EXT4_LINK_MAX 65000
73 * Macro-instructions used to manage several block sizes
75 #define EXT4_MIN_BLOCK_SIZE 1024
76 #define EXT4_MAX_BLOCK_SIZE 4096
77 #define EXT4_MIN_BLOCK_LOG_SIZE 10
79 # define EXT4_BLOCK_SIZE(s) ((s)->s_blocksize)
81 # define EXT4_BLOCK_SIZE(s) (EXT4_MIN_BLOCK_SIZE << (s)->s_log_block_size)
83 #define EXT4_ADDR_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / sizeof (__u32))
85 # define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
87 # define EXT4_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
90 #define EXT4_ADDR_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_addr_per_block_bits)
91 #define EXT4_INODE_SIZE(s) (EXT4_SB(s)->s_inode_size)
92 #define EXT4_FIRST_INO(s) (EXT4_SB(s)->s_first_ino)
94 #define EXT4_INODE_SIZE(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
95 EXT4_GOOD_OLD_INODE_SIZE : \
97 #define EXT4_FIRST_INO(s) (((s)->s_rev_level == EXT4_GOOD_OLD_REV) ? \
98 EXT4_GOOD_OLD_FIRST_INO : \
101 #define EXT4_BLOCK_ALIGN(size, blkbits) ALIGN((size), (1 << (blkbits)))
104 * Structure of a blocks group descriptor
106 struct ext4_group_desc
108 __le32 bg_block_bitmap_lo; /* Blocks bitmap block */
109 __le32 bg_inode_bitmap_lo; /* Inodes bitmap block */
110 __le32 bg_inode_table_lo; /* Inodes table block */
111 __le16 bg_free_blocks_count; /* Free blocks count */
112 __le16 bg_free_inodes_count; /* Free inodes count */
113 __le16 bg_used_dirs_count; /* Directories count */
114 __le16 bg_flags; /* EXT4_BG_flags (INODE_UNINIT, etc) */
115 __u32 bg_reserved[2]; /* Likely block/inode bitmap checksum */
116 __le16 bg_itable_unused; /* Unused inodes count */
117 __le16 bg_checksum; /* crc16(sb_uuid+group+desc) */
118 __le32 bg_block_bitmap_hi; /* Blocks bitmap block MSB */
119 __le32 bg_inode_bitmap_hi; /* Inodes bitmap block MSB */
120 __le32 bg_inode_table_hi; /* Inodes table block MSB */
123 #define EXT4_BG_INODE_UNINIT 0x0001 /* Inode table/bitmap not in use */
124 #define EXT4_BG_BLOCK_UNINIT 0x0002 /* Block bitmap not in use */
125 #define EXT4_BG_INODE_ZEROED 0x0004 /* On-disk itable initialized to zero */
128 #include <linux/ext4_fs_i.h>
129 #include <linux/ext4_fs_sb.h>
132 * Macro-instructions used to manage group descriptors
134 #define EXT4_MIN_DESC_SIZE 32
135 #define EXT4_MIN_DESC_SIZE_64BIT 64
136 #define EXT4_MAX_DESC_SIZE EXT4_MIN_BLOCK_SIZE
137 #define EXT4_DESC_SIZE(s) (EXT4_SB(s)->s_desc_size)
139 # define EXT4_BLOCKS_PER_GROUP(s) (EXT4_SB(s)->s_blocks_per_group)
140 # define EXT4_DESC_PER_BLOCK(s) (EXT4_SB(s)->s_desc_per_block)
141 # define EXT4_INODES_PER_GROUP(s) (EXT4_SB(s)->s_inodes_per_group)
142 # define EXT4_DESC_PER_BLOCK_BITS(s) (EXT4_SB(s)->s_desc_per_block_bits)
144 # define EXT4_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
145 # define EXT4_DESC_PER_BLOCK(s) (EXT4_BLOCK_SIZE(s) / EXT4_DESC_SIZE(s))
146 # define EXT4_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
150 * Constants relative to the data blocks
152 #define EXT4_NDIR_BLOCKS 12
153 #define EXT4_IND_BLOCK EXT4_NDIR_BLOCKS
154 #define EXT4_DIND_BLOCK (EXT4_IND_BLOCK + 1)
155 #define EXT4_TIND_BLOCK (EXT4_DIND_BLOCK + 1)
156 #define EXT4_N_BLOCKS (EXT4_TIND_BLOCK + 1)
161 #define EXT4_SECRM_FL 0x00000001 /* Secure deletion */
162 #define EXT4_UNRM_FL 0x00000002 /* Undelete */
163 #define EXT4_COMPR_FL 0x00000004 /* Compress file */
164 #define EXT4_SYNC_FL 0x00000008 /* Synchronous updates */
165 #define EXT4_IMMUTABLE_FL 0x00000010 /* Immutable file */
166 #define EXT4_APPEND_FL 0x00000020 /* writes to file may only append */
167 #define EXT4_NODUMP_FL 0x00000040 /* do not dump file */
168 #define EXT4_NOATIME_FL 0x00000080 /* do not update atime */
169 /* Reserved for compression usage... */
170 #define EXT4_DIRTY_FL 0x00000100
171 #define EXT4_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
172 #define EXT4_NOCOMPR_FL 0x00000400 /* Don't compress */
173 #define EXT4_ECOMPR_FL 0x00000800 /* Compression error */
174 /* End compression flags --- maybe not all used */
175 #define EXT4_INDEX_FL 0x00001000 /* hash-indexed directory */
176 #define EXT4_IMAGIC_FL 0x00002000 /* AFS directory */
177 #define EXT4_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
178 #define EXT4_NOTAIL_FL 0x00008000 /* file tail should not be merged */
179 #define EXT4_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
180 #define EXT4_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
181 #define EXT4_RESERVED_FL 0x80000000 /* reserved for ext4 lib */
182 #define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
184 #define EXT4_FL_USER_VISIBLE 0x000BDFFF /* User visible flags */
185 #define EXT4_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
188 * Inode dynamic state flags
190 #define EXT4_STATE_JDATA 0x00000001 /* journaled data exists */
191 #define EXT4_STATE_NEW 0x00000002 /* inode is newly created */
192 #define EXT4_STATE_XATTR 0x00000004 /* has in-inode xattrs */
193 #define EXT4_STATE_NO_EXPAND 0x00000008 /* No space for expansion */
195 /* Used to pass group descriptor data when online resize is done */
196 struct ext4_new_group_input {
197 __u32 group; /* Group number for this data */
198 __u64 block_bitmap; /* Absolute block number of block bitmap */
199 __u64 inode_bitmap; /* Absolute block number of inode bitmap */
200 __u64 inode_table; /* Absolute block number of inode table start */
201 __u32 blocks_count; /* Total number of blocks in this group */
202 __u16 reserved_blocks; /* Number of reserved blocks in this group */
206 /* The struct ext4_new_group_input in kernel space, with free_blocks_count */
207 struct ext4_new_group_data {
213 __u16 reserved_blocks;
215 __u32 free_blocks_count;
219 * Following is used by preallocation code to tell get_blocks() that we
220 * want uninitialzed extents.
222 #define EXT4_CREATE_UNINITIALIZED_EXT 2
227 #define EXT4_IOC_GETFLAGS FS_IOC_GETFLAGS
228 #define EXT4_IOC_SETFLAGS FS_IOC_SETFLAGS
229 #define EXT4_IOC_GETVERSION _IOR('f', 3, long)
230 #define EXT4_IOC_SETVERSION _IOW('f', 4, long)
231 #define EXT4_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
232 #define EXT4_IOC_GROUP_ADD _IOW('f', 8,struct ext4_new_group_input)
233 #define EXT4_IOC_GETVERSION_OLD FS_IOC_GETVERSION
234 #define EXT4_IOC_SETVERSION_OLD FS_IOC_SETVERSION
235 #ifdef CONFIG_JBD2_DEBUG
236 #define EXT4_IOC_WAIT_FOR_READONLY _IOR('f', 99, long)
238 #define EXT4_IOC_GETRSVSZ _IOR('f', 5, long)
239 #define EXT4_IOC_SETRSVSZ _IOW('f', 6, long)
242 * ioctl commands in 32 bit emulation
244 #define EXT4_IOC32_GETFLAGS FS_IOC32_GETFLAGS
245 #define EXT4_IOC32_SETFLAGS FS_IOC32_SETFLAGS
246 #define EXT4_IOC32_GETVERSION _IOR('f', 3, int)
247 #define EXT4_IOC32_SETVERSION _IOW('f', 4, int)
248 #define EXT4_IOC32_GETRSVSZ _IOR('f', 5, int)
249 #define EXT4_IOC32_SETRSVSZ _IOW('f', 6, int)
250 #define EXT4_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
251 #ifdef CONFIG_JBD2_DEBUG
252 #define EXT4_IOC32_WAIT_FOR_READONLY _IOR('f', 99, int)
254 #define EXT4_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
255 #define EXT4_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
261 struct ext4_mount_options {
262 unsigned long s_mount_opt;
265 unsigned long s_commit_interval;
268 char *s_qf_names[MAXQUOTAS];
273 * Structure of an inode on the disk
276 __le16 i_mode; /* File mode */
277 __le16 i_uid; /* Low 16 bits of Owner Uid */
278 __le32 i_size; /* Size in bytes */
279 __le32 i_atime; /* Access time */
280 __le32 i_ctime; /* Inode Change time */
281 __le32 i_mtime; /* Modification time */
282 __le32 i_dtime; /* Deletion Time */
283 __le16 i_gid; /* Low 16 bits of Group Id */
284 __le16 i_links_count; /* Links count */
285 __le32 i_blocks; /* Blocks count */
286 __le32 i_flags; /* File flags */
292 __u32 h_i_translator;
297 } osd1; /* OS dependent 1 */
298 __le32 i_block[EXT4_N_BLOCKS];/* Pointers to blocks */
299 __le32 i_generation; /* File version (for NFS) */
300 __le32 i_file_acl; /* File ACL */
301 __le32 i_dir_acl; /* Directory ACL */
302 __le32 i_obso_faddr; /* Obsoleted fragment address */
305 __le16 l_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
306 __le16 l_i_file_acl_high;
307 __le16 l_i_uid_high; /* these 2 fields */
308 __le16 l_i_gid_high; /* were reserved2[0] */
312 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
319 __le16 h_i_reserved1; /* Obsoleted fragment number/size which are removed in ext4 */
320 __le16 m_i_file_acl_high;
321 __u32 m_i_reserved2[2];
323 } osd2; /* OS dependent 2 */
324 __le16 i_extra_isize;
326 __le32 i_ctime_extra; /* extra Change time (nsec << 2 | epoch) */
327 __le32 i_mtime_extra; /* extra Modification time(nsec << 2 | epoch) */
328 __le32 i_atime_extra; /* extra Access time (nsec << 2 | epoch) */
329 __le32 i_crtime; /* File Creation time */
330 __le32 i_crtime_extra; /* extra FileCreationtime (nsec << 2 | epoch) */
333 #define i_size_high i_dir_acl
335 #define EXT4_EPOCH_BITS 2
336 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
337 #define EXT4_NSEC_MASK (~0UL << EXT4_EPOCH_BITS)
340 * Extended fields will fit into an inode if the filesystem was formatted
341 * with large inodes (-I 256 or larger) and there are not currently any EAs
342 * consuming all of the available space. For new inodes we always reserve
343 * enough space for the kernel's known extended fields, but for inodes
344 * created with an old kernel this might not have been the case. None of
345 * the extended inode fields is critical for correct filesystem operation.
346 * This macro checks if a certain field fits in the inode. Note that
347 * inode-size = GOOD_OLD_INODE_SIZE + i_extra_isize
349 #define EXT4_FITS_IN_INODE(ext4_inode, einode, field) \
350 ((offsetof(typeof(*ext4_inode), field) + \
351 sizeof((ext4_inode)->field)) \
352 <= (EXT4_GOOD_OLD_INODE_SIZE + \
353 (einode)->i_extra_isize)) \
355 static inline __le32 ext4_encode_extra_time(struct timespec *time)
357 return cpu_to_le32((sizeof(time->tv_sec) > 4 ?
358 time->tv_sec >> 32 : 0) |
359 ((time->tv_nsec << 2) & EXT4_NSEC_MASK));
362 static inline void ext4_decode_extra_time(struct timespec *time, __le32 extra)
364 if (sizeof(time->tv_sec) > 4)
365 time->tv_sec |= (__u64)(le32_to_cpu(extra) & EXT4_EPOCH_MASK)
367 time->tv_nsec = (le32_to_cpu(extra) & EXT4_NSEC_MASK) >> 2;
370 #define EXT4_INODE_SET_XTIME(xtime, inode, raw_inode) \
372 (raw_inode)->xtime = cpu_to_le32((inode)->xtime.tv_sec); \
373 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) \
374 (raw_inode)->xtime ## _extra = \
375 ext4_encode_extra_time(&(inode)->xtime); \
378 #define EXT4_EINODE_SET_XTIME(xtime, einode, raw_inode) \
380 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
381 (raw_inode)->xtime = cpu_to_le32((einode)->xtime.tv_sec); \
382 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
383 (raw_inode)->xtime ## _extra = \
384 ext4_encode_extra_time(&(einode)->xtime); \
387 #define EXT4_INODE_GET_XTIME(xtime, inode, raw_inode) \
389 (inode)->xtime.tv_sec = (signed)le32_to_cpu((raw_inode)->xtime); \
390 if (EXT4_FITS_IN_INODE(raw_inode, EXT4_I(inode), xtime ## _extra)) \
391 ext4_decode_extra_time(&(inode)->xtime, \
392 raw_inode->xtime ## _extra); \
395 #define EXT4_EINODE_GET_XTIME(xtime, einode, raw_inode) \
397 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime)) \
398 (einode)->xtime.tv_sec = \
399 (signed)le32_to_cpu((raw_inode)->xtime); \
400 if (EXT4_FITS_IN_INODE(raw_inode, einode, xtime ## _extra)) \
401 ext4_decode_extra_time(&(einode)->xtime, \
402 raw_inode->xtime ## _extra); \
405 #if defined(__KERNEL__) || defined(__linux__)
406 #define i_reserved1 osd1.linux1.l_i_reserved1
407 #define i_file_acl_high osd2.linux2.l_i_file_acl_high
408 #define i_uid_low i_uid
409 #define i_gid_low i_gid
410 #define i_uid_high osd2.linux2.l_i_uid_high
411 #define i_gid_high osd2.linux2.l_i_gid_high
412 #define i_reserved2 osd2.linux2.l_i_reserved2
414 #elif defined(__GNU__)
416 #define i_translator osd1.hurd1.h_i_translator
417 #define i_uid_high osd2.hurd2.h_i_uid_high
418 #define i_gid_high osd2.hurd2.h_i_gid_high
419 #define i_author osd2.hurd2.h_i_author
421 #elif defined(__masix__)
423 #define i_reserved1 osd1.masix1.m_i_reserved1
424 #define i_file_acl_high osd2.masix2.m_i_file_acl_high
425 #define i_reserved2 osd2.masix2.m_i_reserved2
427 #endif /* defined(__KERNEL__) || defined(__linux__) */
432 #define EXT4_VALID_FS 0x0001 /* Unmounted cleanly */
433 #define EXT4_ERROR_FS 0x0002 /* Errors detected */
434 #define EXT4_ORPHAN_FS 0x0004 /* Orphans being recovered */
439 #define EXT4_MOUNT_CHECK 0x00001 /* Do mount-time checks */
440 #define EXT4_MOUNT_OLDALLOC 0x00002 /* Don't use the new Orlov allocator */
441 #define EXT4_MOUNT_GRPID 0x00004 /* Create files with directory's group */
442 #define EXT4_MOUNT_DEBUG 0x00008 /* Some debugging messages */
443 #define EXT4_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
444 #define EXT4_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
445 #define EXT4_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
446 #define EXT4_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
447 #define EXT4_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
448 #define EXT4_MOUNT_ABORT 0x00200 /* Fatal error detected */
449 #define EXT4_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
450 #define EXT4_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
451 #define EXT4_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
452 #define EXT4_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
453 #define EXT4_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
454 #define EXT4_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
455 #define EXT4_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
456 #define EXT4_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
457 #define EXT4_MOUNT_RESERVATION 0x10000 /* Preallocation */
458 #define EXT4_MOUNT_BARRIER 0x20000 /* Use block barriers */
459 #define EXT4_MOUNT_NOBH 0x40000 /* No bufferheads */
460 #define EXT4_MOUNT_QUOTA 0x80000 /* Some quota option set */
461 #define EXT4_MOUNT_USRQUOTA 0x100000 /* "old" user quota */
462 #define EXT4_MOUNT_GRPQUOTA 0x200000 /* "old" group quota */
463 #define EXT4_MOUNT_EXTENTS 0x400000 /* Extents support */
465 /* Compatibility, for having both ext2_fs.h and ext4_fs.h included at once */
466 #ifndef _LINUX_EXT2_FS_H
467 #define clear_opt(o, opt) o &= ~EXT4_MOUNT_##opt
468 #define set_opt(o, opt) o |= EXT4_MOUNT_##opt
469 #define test_opt(sb, opt) (EXT4_SB(sb)->s_mount_opt & \
472 #define EXT2_MOUNT_NOLOAD EXT4_MOUNT_NOLOAD
473 #define EXT2_MOUNT_ABORT EXT4_MOUNT_ABORT
474 #define EXT2_MOUNT_DATA_FLAGS EXT4_MOUNT_DATA_FLAGS
477 #define ext4_set_bit ext2_set_bit
478 #define ext4_set_bit_atomic ext2_set_bit_atomic
479 #define ext4_clear_bit ext2_clear_bit
480 #define ext4_clear_bit_atomic ext2_clear_bit_atomic
481 #define ext4_test_bit ext2_test_bit
482 #define ext4_find_first_zero_bit ext2_find_first_zero_bit
483 #define ext4_find_next_zero_bit ext2_find_next_zero_bit
486 * Maximal mount counts between two filesystem checks
488 #define EXT4_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
489 #define EXT4_DFL_CHECKINTERVAL 0 /* Don't use interval check */
492 * Behaviour when detecting errors
494 #define EXT4_ERRORS_CONTINUE 1 /* Continue execution */
495 #define EXT4_ERRORS_RO 2 /* Remount fs read-only */
496 #define EXT4_ERRORS_PANIC 3 /* Panic */
497 #define EXT4_ERRORS_DEFAULT EXT4_ERRORS_CONTINUE
500 * Structure of the super block
502 struct ext4_super_block {
503 /*00*/ __le32 s_inodes_count; /* Inodes count */
504 __le32 s_blocks_count_lo; /* Blocks count */
505 __le32 s_r_blocks_count_lo; /* Reserved blocks count */
506 __le32 s_free_blocks_count_lo; /* Free blocks count */
507 /*10*/ __le32 s_free_inodes_count; /* Free inodes count */
508 __le32 s_first_data_block; /* First Data Block */
509 __le32 s_log_block_size; /* Block size */
510 __le32 s_obso_log_frag_size; /* Obsoleted fragment size */
511 /*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
512 __le32 s_obso_frags_per_group; /* Obsoleted fragments per group */
513 __le32 s_inodes_per_group; /* # Inodes per group */
514 __le32 s_mtime; /* Mount time */
515 /*30*/ __le32 s_wtime; /* Write time */
516 __le16 s_mnt_count; /* Mount count */
517 __le16 s_max_mnt_count; /* Maximal mount count */
518 __le16 s_magic; /* Magic signature */
519 __le16 s_state; /* File system state */
520 __le16 s_errors; /* Behaviour when detecting errors */
521 __le16 s_minor_rev_level; /* minor revision level */
522 /*40*/ __le32 s_lastcheck; /* time of last check */
523 __le32 s_checkinterval; /* max. time between checks */
524 __le32 s_creator_os; /* OS */
525 __le32 s_rev_level; /* Revision level */
526 /*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
527 __le16 s_def_resgid; /* Default gid for reserved blocks */
529 * These fields are for EXT4_DYNAMIC_REV superblocks only.
531 * Note: the difference between the compatible feature set and
532 * the incompatible feature set is that if there is a bit set
533 * in the incompatible feature set that the kernel doesn't
534 * know about, it should refuse to mount the filesystem.
536 * e2fsck's requirements are more strict; if it doesn't know
537 * about a feature in either the compatible or incompatible
538 * feature set, it must abort and not try to meddle with
539 * things it doesn't understand...
541 __le32 s_first_ino; /* First non-reserved inode */
542 __le16 s_inode_size; /* size of inode structure */
543 __le16 s_block_group_nr; /* block group # of this superblock */
544 __le32 s_feature_compat; /* compatible feature set */
545 /*60*/ __le32 s_feature_incompat; /* incompatible feature set */
546 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
547 /*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
548 /*78*/ char s_volume_name[16]; /* volume name */
549 /*88*/ char s_last_mounted[64]; /* directory where last mounted */
550 /*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
552 * Performance hints. Directory preallocation should only
553 * happen if the EXT4_FEATURE_COMPAT_DIR_PREALLOC flag is on.
555 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
556 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
557 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
559 * Journaling support valid if EXT4_FEATURE_COMPAT_HAS_JOURNAL set.
561 /*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
562 /*E0*/ __le32 s_journal_inum; /* inode number of journal file */
563 __le32 s_journal_dev; /* device number of journal file */
564 __le32 s_last_orphan; /* start of list of inodes to delete */
565 __le32 s_hash_seed[4]; /* HTREE hash seed */
566 __u8 s_def_hash_version; /* Default hash version to use */
567 __u8 s_reserved_char_pad;
568 __le16 s_desc_size; /* size of group descriptor */
569 /*100*/ __le32 s_default_mount_opts;
570 __le32 s_first_meta_bg; /* First metablock block group */
571 __le32 s_mkfs_time; /* When the filesystem was created */
572 __le32 s_jnl_blocks[17]; /* Backup of the journal inode */
573 /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
574 /*150*/ __le32 s_blocks_count_hi; /* Blocks count */
575 __le32 s_r_blocks_count_hi; /* Reserved blocks count */
576 __le32 s_free_blocks_count_hi; /* Free blocks count */
577 __le16 s_min_extra_isize; /* All inodes have at least # bytes */
578 __le16 s_want_extra_isize; /* New inodes should reserve # bytes */
579 __le32 s_flags; /* Miscellaneous flags */
580 __le16 s_raid_stride; /* RAID stride */
581 __le16 s_mmp_interval; /* # seconds to wait in MMP checking */
582 __le64 s_mmp_block; /* Block for multi-mount protection */
583 __le32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
584 __u32 s_reserved[163]; /* Padding to the end of the block */
588 static inline struct ext4_sb_info * EXT4_SB(struct super_block *sb)
590 return sb->s_fs_info;
592 static inline struct ext4_inode_info *EXT4_I(struct inode *inode)
594 return container_of(inode, struct ext4_inode_info, vfs_inode);
597 static inline struct timespec ext4_current_time(struct inode *inode)
599 return (inode->i_sb->s_time_gran < NSEC_PER_SEC) ?
600 current_fs_time(inode->i_sb) : CURRENT_TIME_SEC;
604 static inline int ext4_valid_inum(struct super_block *sb, unsigned long ino)
606 return ino == EXT4_ROOT_INO ||
607 ino == EXT4_JOURNAL_INO ||
608 ino == EXT4_RESIZE_INO ||
609 (ino >= EXT4_FIRST_INO(sb) &&
610 ino <= le32_to_cpu(EXT4_SB(sb)->s_es->s_inodes_count));
613 /* Assume that user mode programs are passing in an ext4fs superblock, not
614 * a kernel struct super_block. This will allow us to call the feature-test
615 * macros from user land. */
616 #define EXT4_SB(sb) (sb)
619 #define NEXT_ORPHAN(inode) EXT4_I(inode)->i_dtime
622 * Codes for operating systems
624 #define EXT4_OS_LINUX 0
625 #define EXT4_OS_HURD 1
626 #define EXT4_OS_MASIX 2
627 #define EXT4_OS_FREEBSD 3
628 #define EXT4_OS_LITES 4
633 #define EXT4_GOOD_OLD_REV 0 /* The good old (original) format */
634 #define EXT4_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
636 #define EXT4_CURRENT_REV EXT4_GOOD_OLD_REV
637 #define EXT4_MAX_SUPP_REV EXT4_DYNAMIC_REV
639 #define EXT4_GOOD_OLD_INODE_SIZE 128
642 * Feature set definitions
645 #define EXT4_HAS_COMPAT_FEATURE(sb,mask) \
646 ( EXT4_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
647 #define EXT4_HAS_RO_COMPAT_FEATURE(sb,mask) \
648 ( EXT4_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
649 #define EXT4_HAS_INCOMPAT_FEATURE(sb,mask) \
650 ( EXT4_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
651 #define EXT4_SET_COMPAT_FEATURE(sb,mask) \
652 EXT4_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
653 #define EXT4_SET_RO_COMPAT_FEATURE(sb,mask) \
654 EXT4_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
655 #define EXT4_SET_INCOMPAT_FEATURE(sb,mask) \
656 EXT4_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
657 #define EXT4_CLEAR_COMPAT_FEATURE(sb,mask) \
658 EXT4_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
659 #define EXT4_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
660 EXT4_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
661 #define EXT4_CLEAR_INCOMPAT_FEATURE(sb,mask) \
662 EXT4_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
664 #define EXT4_FEATURE_COMPAT_DIR_PREALLOC 0x0001
665 #define EXT4_FEATURE_COMPAT_IMAGIC_INODES 0x0002
666 #define EXT4_FEATURE_COMPAT_HAS_JOURNAL 0x0004
667 #define EXT4_FEATURE_COMPAT_EXT_ATTR 0x0008
668 #define EXT4_FEATURE_COMPAT_RESIZE_INODE 0x0010
669 #define EXT4_FEATURE_COMPAT_DIR_INDEX 0x0020
671 #define EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
672 #define EXT4_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
673 #define EXT4_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
674 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM 0x0010
675 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK 0x0020
676 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE 0x0040
678 #define EXT4_FEATURE_INCOMPAT_COMPRESSION 0x0001
679 #define EXT4_FEATURE_INCOMPAT_FILETYPE 0x0002
680 #define EXT4_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
681 #define EXT4_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
682 #define EXT4_FEATURE_INCOMPAT_META_BG 0x0010
683 #define EXT4_FEATURE_INCOMPAT_EXTENTS 0x0040 /* extents support */
684 #define EXT4_FEATURE_INCOMPAT_64BIT 0x0080
685 #define EXT4_FEATURE_INCOMPAT_FLEX_BG 0x0200
687 #define EXT4_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
688 #define EXT4_FEATURE_INCOMPAT_SUPP (EXT4_FEATURE_INCOMPAT_FILETYPE| \
689 EXT4_FEATURE_INCOMPAT_RECOVER| \
690 EXT4_FEATURE_INCOMPAT_META_BG| \
691 EXT4_FEATURE_INCOMPAT_EXTENTS| \
692 EXT4_FEATURE_INCOMPAT_64BIT| \
693 EXT4_FEATURE_INCOMPAT_FLEX_BG)
694 #define EXT4_FEATURE_RO_COMPAT_SUPP (EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER| \
695 EXT4_FEATURE_RO_COMPAT_LARGE_FILE| \
696 EXT4_FEATURE_RO_COMPAT_GDT_CSUM| \
697 EXT4_FEATURE_RO_COMPAT_DIR_NLINK | \
698 EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE | \
699 EXT4_FEATURE_RO_COMPAT_BTREE_DIR)
702 * Default values for user and/or group using reserved blocks
704 #define EXT4_DEF_RESUID 0
705 #define EXT4_DEF_RESGID 0
708 * Default mount options
710 #define EXT4_DEFM_DEBUG 0x0001
711 #define EXT4_DEFM_BSDGROUPS 0x0002
712 #define EXT4_DEFM_XATTR_USER 0x0004
713 #define EXT4_DEFM_ACL 0x0008
714 #define EXT4_DEFM_UID16 0x0010
715 #define EXT4_DEFM_JMODE 0x0060
716 #define EXT4_DEFM_JMODE_DATA 0x0020
717 #define EXT4_DEFM_JMODE_ORDERED 0x0040
718 #define EXT4_DEFM_JMODE_WBACK 0x0060
721 * Structure of a directory entry
723 #define EXT4_NAME_LEN 255
725 struct ext4_dir_entry {
726 __le32 inode; /* Inode number */
727 __le16 rec_len; /* Directory entry length */
728 __le16 name_len; /* Name length */
729 char name[EXT4_NAME_LEN]; /* File name */
733 * The new version of the directory entry. Since EXT4 structures are
734 * stored in intel byte order, and the name_len field could never be
735 * bigger than 255 chars, it's safe to reclaim the extra byte for the
738 struct ext4_dir_entry_2 {
739 __le32 inode; /* Inode number */
740 __le16 rec_len; /* Directory entry length */
741 __u8 name_len; /* Name length */
743 char name[EXT4_NAME_LEN]; /* File name */
747 * Ext4 directory file types. Only the low 3 bits are used. The
748 * other bits are reserved for now.
750 #define EXT4_FT_UNKNOWN 0
751 #define EXT4_FT_REG_FILE 1
752 #define EXT4_FT_DIR 2
753 #define EXT4_FT_CHRDEV 3
754 #define EXT4_FT_BLKDEV 4
755 #define EXT4_FT_FIFO 5
756 #define EXT4_FT_SOCK 6
757 #define EXT4_FT_SYMLINK 7
759 #define EXT4_FT_MAX 8
762 * EXT4_DIR_PAD defines the directory entries boundaries
764 * NOTE: It must be a multiple of 4
766 #define EXT4_DIR_PAD 4
767 #define EXT4_DIR_ROUND (EXT4_DIR_PAD - 1)
768 #define EXT4_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT4_DIR_ROUND) & \
771 * Hash Tree Directory indexing
772 * (c) Daniel Phillips, 2001
775 #define is_dx(dir) (EXT4_HAS_COMPAT_FEATURE(dir->i_sb, \
776 EXT4_FEATURE_COMPAT_DIR_INDEX) && \
777 (EXT4_I(dir)->i_flags & EXT4_INDEX_FL))
778 #define EXT4_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT4_LINK_MAX)
779 #define EXT4_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
781 /* Legal values for the dx_root hash_version field: */
783 #define DX_HASH_LEGACY 0
784 #define DX_HASH_HALF_MD4 1
785 #define DX_HASH_TEA 2
789 /* hash info structure used by the directory hash */
798 #define EXT4_HTREE_EOF 0x7fffffff
801 * Control parameters used by ext4_htree_next_block
803 #define HASH_NB_ALWAYS 1
807 * Describe an inode's exact location on disk and in memory
811 struct buffer_head *bh;
812 unsigned long offset;
813 unsigned long block_group;
816 static inline struct ext4_inode *ext4_raw_inode(struct ext4_iloc *iloc)
818 return (struct ext4_inode *) (iloc->bh->b_data + iloc->offset);
822 * This structure is stuffed into the struct file's private_data field
823 * for directories. It is where we put information so that we can do
824 * readdir operations in hash tree order.
826 struct dir_private_info {
828 struct rb_node *curr_node;
829 struct fname *extra_fname;
832 __u32 curr_minor_hash;
836 /* calculate the first block number of the group */
837 static inline ext4_fsblk_t
838 ext4_group_first_block_no(struct super_block *sb, unsigned long group_no)
840 return group_no * (ext4_fsblk_t)EXT4_BLOCKS_PER_GROUP(sb) +
841 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block);
845 * Special error return code only used by dx_probe() and its callers.
847 #define ERR_BAD_DX_DIR -75000
849 void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
850 unsigned long *blockgrpp, ext4_grpblk_t *offsetp);
853 * Function prototypes
857 * Ok, these declarations are also in <linux/kernel.h> but none of the
858 * ext4 source programs needs to include it so they are duplicated here.
860 # define NORET_TYPE /**/
861 # define ATTRIB_NORET __attribute__((noreturn))
862 # define NORET_AND noreturn,
865 extern unsigned int ext4_block_group(struct super_block *sb,
866 ext4_fsblk_t blocknr);
867 extern ext4_grpblk_t ext4_block_group_offset(struct super_block *sb,
868 ext4_fsblk_t blocknr);
869 extern int ext4_bg_has_super(struct super_block *sb, int group);
870 extern unsigned long ext4_bg_num_gdb(struct super_block *sb, int group);
871 extern ext4_fsblk_t ext4_new_block (handle_t *handle, struct inode *inode,
872 ext4_fsblk_t goal, int *errp);
873 extern ext4_fsblk_t ext4_new_blocks (handle_t *handle, struct inode *inode,
874 ext4_fsblk_t goal, unsigned long *count, int *errp);
875 extern void ext4_free_blocks (handle_t *handle, struct inode *inode,
876 ext4_fsblk_t block, unsigned long count);
877 extern void ext4_free_blocks_sb (handle_t *handle, struct super_block *sb,
878 ext4_fsblk_t block, unsigned long count,
879 unsigned long *pdquot_freed_blocks);
880 extern ext4_fsblk_t ext4_count_free_blocks (struct super_block *);
881 extern void ext4_check_blocks_bitmap (struct super_block *);
882 extern struct ext4_group_desc * ext4_get_group_desc(struct super_block * sb,
883 unsigned int block_group,
884 struct buffer_head ** bh);
885 extern int ext4_should_retry_alloc(struct super_block *sb, int *retries);
886 extern void ext4_init_block_alloc_info(struct inode *);
887 extern void ext4_rsv_window_add(struct super_block *sb, struct ext4_reserve_window_node *rsv);
890 extern int ext4_check_dir_entry(const char *, struct inode *,
891 struct ext4_dir_entry_2 *,
892 struct buffer_head *, unsigned long);
893 extern int ext4_htree_store_dirent(struct file *dir_file, __u32 hash,
895 struct ext4_dir_entry_2 *dirent);
896 extern void ext4_htree_free_dir_info(struct dir_private_info *p);
899 extern int ext4_sync_file (struct file *, struct dentry *, int);
902 extern int ext4fs_dirhash(const char *name, int len, struct
903 dx_hash_info *hinfo);
906 extern struct inode * ext4_new_inode (handle_t *, struct inode *, int);
907 extern void ext4_free_inode (handle_t *, struct inode *);
908 extern struct inode * ext4_orphan_get (struct super_block *, unsigned long);
909 extern unsigned long ext4_count_free_inodes (struct super_block *);
910 extern unsigned long ext4_count_dirs (struct super_block *);
911 extern void ext4_check_inodes_bitmap (struct super_block *);
912 extern unsigned long ext4_count_free (struct buffer_head *, unsigned);
916 int ext4_forget(handle_t *handle, int is_metadata, struct inode *inode,
917 struct buffer_head *bh, ext4_fsblk_t blocknr);
918 struct buffer_head * ext4_getblk (handle_t *, struct inode *, long, int, int *);
919 struct buffer_head * ext4_bread (handle_t *, struct inode *, int, int, int *);
920 int ext4_get_blocks_handle(handle_t *handle, struct inode *inode,
921 sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
922 int create, int extend_disksize);
924 extern void ext4_read_inode (struct inode *);
925 extern int ext4_write_inode (struct inode *, int);
926 extern int ext4_setattr (struct dentry *, struct iattr *);
927 extern void ext4_delete_inode (struct inode *);
928 extern int ext4_sync_inode (handle_t *, struct inode *);
929 extern void ext4_discard_reservation (struct inode *);
930 extern void ext4_dirty_inode(struct inode *);
931 extern int ext4_change_inode_journal_flag(struct inode *, int);
932 extern int ext4_get_inode_loc(struct inode *, struct ext4_iloc *);
933 extern void ext4_truncate (struct inode *);
934 extern void ext4_set_inode_flags(struct inode *);
935 extern void ext4_get_inode_flags(struct ext4_inode_info *);
936 extern void ext4_set_aops(struct inode *inode);
937 extern int ext4_writepage_trans_blocks(struct inode *);
938 extern int ext4_block_truncate_page(handle_t *handle, struct page *page,
939 struct address_space *mapping, loff_t from);
942 extern int ext4_ioctl (struct inode *, struct file *, unsigned int,
944 extern long ext4_compat_ioctl (struct file *, unsigned int, unsigned long);
947 extern int ext4_orphan_add(handle_t *, struct inode *);
948 extern int ext4_orphan_del(handle_t *, struct inode *);
949 extern int ext4_htree_fill_tree(struct file *dir_file, __u32 start_hash,
950 __u32 start_minor_hash, __u32 *next_hash);
953 extern int ext4_group_add(struct super_block *sb,
954 struct ext4_new_group_data *input);
955 extern int ext4_group_extend(struct super_block *sb,
956 struct ext4_super_block *es,
957 ext4_fsblk_t n_blocks_count);
960 extern void ext4_error (struct super_block *, const char *, const char *, ...)
961 __attribute__ ((format (printf, 3, 4)));
962 extern void __ext4_std_error (struct super_block *, const char *, int);
963 extern void ext4_abort (struct super_block *, const char *, const char *, ...)
964 __attribute__ ((format (printf, 3, 4)));
965 extern void ext4_warning (struct super_block *, const char *, const char *, ...)
966 __attribute__ ((format (printf, 3, 4)));
967 extern void ext4_update_dynamic_rev (struct super_block *sb);
968 extern ext4_fsblk_t ext4_block_bitmap(struct super_block *sb,
969 struct ext4_group_desc *bg);
970 extern ext4_fsblk_t ext4_inode_bitmap(struct super_block *sb,
971 struct ext4_group_desc *bg);
972 extern ext4_fsblk_t ext4_inode_table(struct super_block *sb,
973 struct ext4_group_desc *bg);
974 extern void ext4_block_bitmap_set(struct super_block *sb,
975 struct ext4_group_desc *bg, ext4_fsblk_t blk);
976 extern void ext4_inode_bitmap_set(struct super_block *sb,
977 struct ext4_group_desc *bg, ext4_fsblk_t blk);
978 extern void ext4_inode_table_set(struct super_block *sb,
979 struct ext4_group_desc *bg, ext4_fsblk_t blk);
981 static inline ext4_fsblk_t ext4_blocks_count(struct ext4_super_block *es)
983 return ((ext4_fsblk_t)le32_to_cpu(es->s_blocks_count_hi) << 32) |
984 le32_to_cpu(es->s_blocks_count_lo);
987 static inline ext4_fsblk_t ext4_r_blocks_count(struct ext4_super_block *es)
989 return ((ext4_fsblk_t)le32_to_cpu(es->s_r_blocks_count_hi) << 32) |
990 le32_to_cpu(es->s_r_blocks_count_lo);
993 static inline ext4_fsblk_t ext4_free_blocks_count(struct ext4_super_block *es)
995 return ((ext4_fsblk_t)le32_to_cpu(es->s_free_blocks_count_hi) << 32) |
996 le32_to_cpu(es->s_free_blocks_count_lo);
999 static inline void ext4_blocks_count_set(struct ext4_super_block *es,
1002 es->s_blocks_count_lo = cpu_to_le32((u32)blk);
1003 es->s_blocks_count_hi = cpu_to_le32(blk >> 32);
1006 static inline void ext4_free_blocks_count_set(struct ext4_super_block *es,
1009 es->s_free_blocks_count_lo = cpu_to_le32((u32)blk);
1010 es->s_free_blocks_count_hi = cpu_to_le32(blk >> 32);
1013 static inline void ext4_r_blocks_count_set(struct ext4_super_block *es,
1016 es->s_r_blocks_count_lo = cpu_to_le32((u32)blk);
1017 es->s_r_blocks_count_hi = cpu_to_le32(blk >> 32);
1022 #define ext4_std_error(sb, errno) \
1025 __ext4_std_error((sb), __FUNCTION__, (errno)); \
1029 * Inodes and files operations
1033 extern const struct file_operations ext4_dir_operations;
1036 extern const struct inode_operations ext4_file_inode_operations;
1037 extern const struct file_operations ext4_file_operations;
1040 extern const struct inode_operations ext4_dir_inode_operations;
1041 extern const struct inode_operations ext4_special_inode_operations;
1044 extern const struct inode_operations ext4_symlink_inode_operations;
1045 extern const struct inode_operations ext4_fast_symlink_inode_operations;
1048 extern int ext4_ext_tree_init(handle_t *handle, struct inode *);
1049 extern int ext4_ext_writepage_trans_blocks(struct inode *, int);
1050 extern int ext4_ext_get_blocks(handle_t *handle, struct inode *inode,
1051 ext4_fsblk_t iblock,
1052 unsigned long max_blocks, struct buffer_head *bh_result,
1053 int create, int extend_disksize);
1054 extern void ext4_ext_truncate(struct inode *, struct page *);
1055 extern void ext4_ext_init(struct super_block *);
1056 extern void ext4_ext_release(struct super_block *);
1057 extern long ext4_fallocate(struct inode *inode, int mode, loff_t offset,
1060 ext4_get_blocks_wrap(handle_t *handle, struct inode *inode, sector_t block,
1061 unsigned long max_blocks, struct buffer_head *bh,
1062 int create, int extend_disksize)
1064 if (EXT4_I(inode)->i_flags & EXT4_EXTENTS_FL)
1065 return ext4_ext_get_blocks(handle, inode, block, max_blocks,
1066 bh, create, extend_disksize);
1067 return ext4_get_blocks_handle(handle, inode, block, max_blocks, bh,
1068 create, extend_disksize);
1072 #endif /* __KERNEL__ */
1074 #endif /* _LINUX_EXT4_FS_H */