2 * linux/include/linux/ext2_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 /* Private copy for extlinux */
18 #ifndef _LINUX_EXT2_FS_H
19 #define _LINUX_EXT2_FS_H
21 #include <linux/types.h>
24 * The second extended filesystem constants/structures
28 * Define EXT2FS_DEBUG to produce debug messages
33 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
35 #define EXT2_PREALLOCATE
36 #define EXT2_DEFAULT_PREALLOC_BLOCKS 8
39 * The second extended file system version
41 #define EXT2FS_DATE "95/08/09"
42 #define EXT2FS_VERSION "0.5b"
48 # define ext2_debug(f, a...) { \
49 printk ("EXT2-fs DEBUG (%s, %d): %s:", \
50 __FILE__, __LINE__, __FUNCTION__); \
54 # define ext2_debug(f, a...) /**/
57 * Special inode numbers
59 #define EXT2_BAD_INO 1 /* Bad blocks inode */
60 #define EXT2_ROOT_INO 2 /* Root inode */
61 #define EXT2_ACL_IDX_INO 3 /* ACL inode */
62 #define EXT2_ACL_DATA_INO 4 /* ACL inode */
63 #define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
64 #define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
65 /* First non-reserved inode for old ext2 filesystems */
66 #define EXT2_GOOD_OLD_FIRST_INO 11
68 * The second extended file system magic number
70 #define EXT2_SUPER_MAGIC 0xEF53
72 * Maximal count of links to a file
74 #define EXT2_LINK_MAX 32000
76 * Macro-instructions used to manage several block sizes
78 #define EXT2_MIN_BLOCK_SIZE 1024
79 #define EXT2_MAX_BLOCK_SIZE 4096
80 #define EXT2_MIN_BLOCK_LOG_SIZE 10
81 # define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
82 #define EXT2_ACLE_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_acl_entry))
83 #define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (__u32))
84 # define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
85 #define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
86 EXT2_GOOD_OLD_INODE_SIZE : \
88 #define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
89 EXT2_GOOD_OLD_FIRST_INO : \
92 * Macro-instructions used to manage fragments
94 #define EXT2_MIN_FRAG_SIZE 1024
95 #define EXT2_MAX_FRAG_SIZE 4096
96 #define EXT2_MIN_FRAG_LOG_SIZE 10
97 # define EXT2_FRAG_SIZE(s) (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
98 # define EXT2_FRAGS_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
102 struct ext2_acl_header
{ /* Header of Access Control Lists */
104 __u32 aclh_file_count
;
105 __u32 aclh_acle_count
;
106 __u32 aclh_first_acle
;
109 struct ext2_acl_entry
{ /* Access Control List Entry */
111 __u16 acle_perms
; /* Access permissions */
112 __u16 acle_type
; /* Type of entry */
113 __u16 acle_tag
; /* User or group identity */
115 __u32 acle_next
; /* Pointer on next entry for the */
116 /* same inode or on next free entry */
120 * Structure of a blocks group descriptor
122 struct ext2_group_desc
{
123 __u32 bg_block_bitmap
; /* Blocks bitmap block */
124 __u32 bg_inode_bitmap
; /* Inodes bitmap block */
125 __u32 bg_inode_table
; /* Inodes table block */
126 __u16 bg_free_blocks_count
; /* Free blocks count */
127 __u16 bg_free_inodes_count
; /* Free inodes count */
128 __u16 bg_used_dirs_count
; /* Directories count */
130 __u32 bg_reserved
[3];
134 * Macro-instructions used to manage group descriptors
136 # define EXT2_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
137 # define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_group_desc))
138 # define EXT2_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
141 * Constants relative to the data blocks
143 #define EXT2_NDIR_BLOCKS 12
144 #define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
145 #define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
146 #define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
147 #define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
152 #define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
153 #define EXT2_UNRM_FL 0x00000002 /* Undelete */
154 #define EXT2_COMPR_FL 0x00000004 /* Compress file */
155 #define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
156 #define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
157 #define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
158 #define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
159 #define EXT2_NOATIME_FL 0x00000080 /* do not update atime */
160 /* Reserved for compression usage... */
161 #define EXT2_DIRTY_FL 0x00000100
162 #define EXT2_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
163 #define EXT2_NOCOMP_FL 0x00000400 /* Don't compress */
164 #define EXT2_ECOMPR_FL 0x00000800 /* Compression error */
165 /* End compression flags --- maybe not all used */
166 #define EXT2_BTREE_FL 0x00001000 /* btree format dir */
167 #define EXT2_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
169 #define EXT2_FL_USER_VISIBLE 0x00001FFF /* User visible flags */
170 #define EXT2_FL_USER_MODIFIABLE 0x000000FF /* User modifiable flags */
175 #define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
176 #define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
177 #define EXT2_IOC_GETVERSION _IOR('v', 1, long)
178 #define EXT2_IOC_SETVERSION _IOW('v', 2, long)
181 * Structure of an inode on the disk
184 __u16 i_mode
; /* File mode */
185 __u16 i_uid
; /* Low 16 bits of Owner Uid */
186 __u32 i_size
; /* Size in bytes */
187 __u32 i_atime
; /* Access time */
188 __u32 i_ctime
; /* Creation time */
189 __u32 i_mtime
; /* Modification time */
190 __u32 i_dtime
; /* Deletion Time */
191 __u16 i_gid
; /* Low 16 bits of Group Id */
192 __u16 i_links_count
; /* Links count */
193 __u32 i_blocks
; /* Blocks count */
194 __u32 i_flags
; /* File flags */
200 __u32 h_i_translator
;
205 } osd1
; /* OS dependent 1 */
206 __u32 i_block
[EXT2_N_BLOCKS
]; /* Pointers to blocks */
207 __u32 i_generation
; /* File version (for NFS) */
208 __u32 i_file_acl
; /* File ACL */
209 __u32 i_dir_acl
; /* Directory ACL */
210 __u32 i_faddr
; /* Fragment address */
213 __u8 l_i_frag
; /* Fragment number */
214 __u8 l_i_fsize
; /* Fragment size */
216 __u16 l_i_uid_high
; /* these 2 fields */
217 __u16 l_i_gid_high
; /* were reserved2[0] */
221 __u8 h_i_frag
; /* Fragment number */
222 __u8 h_i_fsize
; /* Fragment size */
229 __u8 m_i_frag
; /* Fragment number */
230 __u8 m_i_fsize
; /* Fragment size */
232 __u32 m_i_reserved2
[2];
234 } osd2
; /* OS dependent 2 */
237 #define i_size_high i_dir_acl
239 #if defined(__KERNEL__) || defined(__linux__)
240 #define i_reserved1 osd1.linux1.l_i_reserved1
241 #define i_frag osd2.linux2.l_i_frag
242 #define i_fsize osd2.linux2.l_i_fsize
243 #define i_uid_low i_uid
244 #define i_gid_low i_gid
245 #define i_uid_high osd2.linux2.l_i_uid_high
246 #define i_gid_high osd2.linux2.l_i_gid_high
247 #define i_reserved2 osd2.linux2.l_i_reserved2
251 #define i_translator osd1.hurd1.h_i_translator
252 #define i_frag osd2.hurd2.h_i_frag;
253 #define i_fsize osd2.hurd2.h_i_fsize;
254 #define i_uid_high osd2.hurd2.h_i_uid_high
255 #define i_gid_high osd2.hurd2.h_i_gid_high
256 #define i_author osd2.hurd2.h_i_author
260 #define i_reserved1 osd1.masix1.m_i_reserved1
261 #define i_frag osd2.masix2.m_i_frag
262 #define i_fsize osd2.masix2.m_i_fsize
263 #define i_reserved2 osd2.masix2.m_i_reserved2
269 #define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
270 #define EXT2_ERROR_FS 0x0002 /* Errors detected */
275 #define EXT2_MOUNT_CHECK 0x0001 /* Do mount-time checks */
276 #define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
277 #define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
278 #define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
279 #define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
280 #define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
281 #define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
282 #define EXT2_MOUNT_NO_UID32 0x0200 /* Disable 32-bit UIDs */
284 #define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
285 #define set_opt(o, opt) o |= EXT2_MOUNT_##opt
286 #define test_opt(sb, opt) ((sb)->u.ext2_sb.s_mount_opt & \
289 * Maximal mount counts between two filesystem checks
291 #define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
292 #define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
295 * Behaviour when detecting errors
297 #define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
298 #define EXT2_ERRORS_RO 2 /* Remount fs read-only */
299 #define EXT2_ERRORS_PANIC 3 /* Panic */
300 #define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
303 * Structure of the super block
305 struct ext2_super_block
{
306 __u32 s_inodes_count
; /* Inodes count */
307 __u32 s_blocks_count
; /* Blocks count */
308 __u32 s_r_blocks_count
; /* Reserved blocks count */
309 __u32 s_free_blocks_count
; /* Free blocks count */
310 __u32 s_free_inodes_count
; /* Free inodes count */
311 __u32 s_first_data_block
; /* First Data Block */
312 __u32 s_log_block_size
; /* Block size */
313 __s32 s_log_frag_size
; /* Fragment size */
314 __u32 s_blocks_per_group
; /* # Blocks per group */
315 __u32 s_frags_per_group
; /* # Fragments per group */
316 __u32 s_inodes_per_group
; /* # Inodes per group */
317 __u32 s_mtime
; /* Mount time */
318 __u32 s_wtime
; /* Write time */
319 __u16 s_mnt_count
; /* Mount count */
320 __s16 s_max_mnt_count
; /* Maximal mount count */
321 __u16 s_magic
; /* Magic signature */
322 __u16 s_state
; /* File system state */
323 __u16 s_errors
; /* Behaviour when detecting errors */
324 __u16 s_minor_rev_level
; /* minor revision level */
325 __u32 s_lastcheck
; /* time of last check */
326 __u32 s_checkinterval
; /* max. time between checks */
327 __u32 s_creator_os
; /* OS */
328 __u32 s_rev_level
; /* Revision level */
329 __u16 s_def_resuid
; /* Default uid for reserved blocks */
330 __u16 s_def_resgid
; /* Default gid for reserved blocks */
332 * These fields are for EXT2_DYNAMIC_REV superblocks only.
334 * Note: the difference between the compatible feature set and
335 * the incompatible feature set is that if there is a bit set
336 * in the incompatible feature set that the kernel doesn't
337 * know about, it should refuse to mount the filesystem.
339 * e2fsck's requirements are more strict; if it doesn't know
340 * about a feature in either the compatible or incompatible
341 * feature set, it must abort and not try to meddle with
342 * things it doesn't understand...
344 __u32 s_first_ino
; /* First non-reserved inode */
345 __u16 s_inode_size
; /* size of inode structure */
346 __u16 s_block_group_nr
; /* block group # of this superblock */
347 __u32 s_feature_compat
; /* compatible feature set */
348 __u32 s_feature_incompat
; /* incompatible feature set */
349 __u32 s_feature_ro_compat
; /* readonly-compatible feature set */
350 __u8 s_uuid
[16]; /* 128-bit uuid for volume */
351 char s_volume_name
[16]; /* volume name */
352 char s_last_mounted
[64]; /* directory where last mounted */
353 __u32 s_algorithm_usage_bitmap
; /* For compression */
355 * Performance hints. Directory preallocation should only
356 * happen if the EXT2_COMPAT_PREALLOC flag is on.
358 __u8 s_prealloc_blocks
; /* Nr of blocks to try to preallocate */
359 __u8 s_prealloc_dir_blocks
; /* Nr to preallocate for dirs */
361 __u32 s_reserved
[204]; /* Padding to the end of the block */
364 /* Assume that user mode programs are passing in an ext2fs superblock, not
365 * a kernel struct super_block. This will allow us to call the feature-test
366 * macros from user land. */
367 #define EXT2_SB(sb) (sb)
370 * Codes for operating systems
372 #define EXT2_OS_LINUX 0
373 #define EXT2_OS_HURD 1
374 #define EXT2_OS_MASIX 2
375 #define EXT2_OS_FREEBSD 3
376 #define EXT2_OS_LITES 4
381 #define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
382 #define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
384 #define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
385 #define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
387 #define EXT2_GOOD_OLD_INODE_SIZE 128
390 * Feature set definitions
393 #define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
394 ( EXT2_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
395 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
396 ( EXT2_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
397 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
398 ( EXT2_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
399 #define EXT2_SET_COMPAT_FEATURE(sb,mask) \
400 EXT2_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
401 #define EXT2_SET_RO_COMPAT_FEATURE(sb,mask) \
402 EXT2_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
403 #define EXT2_SET_INCOMPAT_FEATURE(sb,mask) \
404 EXT2_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
405 #define EXT2_CLEAR_COMPAT_FEATURE(sb,mask) \
406 EXT2_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
407 #define EXT2_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
408 EXT2_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
409 #define EXT2_CLEAR_INCOMPAT_FEATURE(sb,mask) \
410 EXT2_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
412 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
413 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES 0x0002
414 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
415 #define EXT2_FEATURE_COMPAT_EXT_ATTR 0x0008
416 #define EXT2_FEATURE_COMPAT_RESIZE_INO 0x0010
417 #define EXT2_FEATURE_COMPAT_DIR_INDEX 0x0020
418 #define EXT2_FEATURE_COMPAT_ANY 0xffffffff
420 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
421 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
422 #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
423 #define EXT2_FEATURE_RO_COMPAT_ANY 0xffffffff
425 #define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
426 #define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
427 #define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004
428 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008
429 #define EXT2_FEATURE_INCOMPAT_ANY 0xffffffff
431 #define EXT2_FEATURE_COMPAT_SUPP 0
432 #define EXT2_FEATURE_INCOMPAT_SUPP EXT2_FEATURE_INCOMPAT_FILETYPE
433 #define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
434 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
435 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
436 #define EXT2_FEATURE_RO_COMPAT_UNSUPPORTED ~EXT2_FEATURE_RO_COMPAT_SUPP
437 #define EXT2_FEATURE_INCOMPAT_UNSUPPORTED ~EXT2_FEATURE_INCOMPAT_SUPP
440 * Default values for user and/or group using reserved blocks
442 #define EXT2_DEF_RESUID 0
443 #define EXT2_DEF_RESGID 0
446 * Structure of a directory entry
448 #define EXT2_NAME_LEN 255
450 struct ext2_dir_entry
{
451 __u32 inode
; /* Inode number */
452 __u16 rec_len
; /* Directory entry length */
453 __u16 name_len
; /* Name length */
454 char name
[EXT2_NAME_LEN
]; /* File name */
458 * The new version of the directory entry. Since EXT2 structures are
459 * stored in intel byte order, and the name_len field could never be
460 * bigger than 255 chars, it's safe to reclaim the extra byte for the
463 struct ext2_dir_entry_2
{
464 __u32 inode
; /* Inode number */
465 __u16 rec_len
; /* Directory entry length */
466 __u8 name_len
; /* Name length */
468 char name
[EXT2_NAME_LEN
]; /* File name */
472 * Ext2 directory file types. Only the low 3 bits are used. The
473 * other bits are reserved for now.
488 * EXT2_DIR_PAD defines the directory entries boundaries
490 * NOTE: It must be a multiple of 4
492 #define EXT2_DIR_PAD 4
493 #define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
494 #define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
497 #endif /* _LINUX_EXT2_FS_H */