2 * modified for EXT2FS support in Lites 1.1
4 * Aug 1995, Godmar Back (gback@cs.utah.edu)
5 * University of Utah, Department of Computer Science
7 * $FreeBSD: src/sys/gnu/ext2fs/ext2_fs.h,v 1.8.2.2 2001/09/29 12:52:47 iedowse Exp $
8 * $DragonFly: src/sys/vfs/gnu/ext2fs/ext2_fs.h,v 1.6 2006/12/23 00:41:29 swildner Exp $
11 * linux/include/linux/ext2_fs.h
13 * Copyright (C) 1992, 1993, 1994, 1995
14 * Remy Card (card@masi.ibp.fr)
15 * Laboratoire MASI - Institut Blaise Pascal
16 * Universite Pierre et Marie Curie (Paris VI)
20 * linux/include/linux/minix_fs.h
22 * Copyright (C) 1991, 1992 Linus Torvalds
25 #ifndef _LINUX_EXT2_FS_H
26 #define _LINUX_EXT2_FS_H
28 #include <sys/types.h>
29 #include <sys/ioccom.h>
31 #define __u32 u_int32_t
33 #define __u16 u_int16_t
40 #define umode_t mode_t
43 /* the Linux implementation of EXT2 stores some information about
44 * an inode in a ext2_inode_info structure which is part of the incore
46 * I decided to use the "spare" fields instead - we'll see how this
50 #define i_block_group i_spare[0]
51 #define i_next_alloc_block i_spare[1]
52 #define i_next_alloc_goal i_spare[2]
53 #define i_prealloc_block i_din.di_spare[0]
54 #define i_prealloc_count i_din.di_spare[1]
57 * The second extended filesystem constants/structures
61 * Define EXT2FS_DEBUG to produce debug messages
66 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
68 #define EXT2_PREALLOCATE
69 #define EXT2_DEFAULT_PREALLOC_BLOCKS 8
72 * The second extended file system version
74 #define EXT2FS_DATE "95/08/09"
75 #define EXT2FS_VERSION "0.5b"
81 # define ext2_debug(f, a...) { \
82 kprintf ("EXT2-fs DEBUG (%s, %d): %s:", \
83 __FILE__, __LINE__, __func__); \
87 # define ext2_debug(f, a...) /**/
91 * Special inodes numbers
93 #define EXT2_BAD_INO 1 /* Bad blocks inode */
94 #define EXT2_ROOT_INO 2 /* Root inode */
95 #define EXT2_ACL_IDX_INO 3 /* ACL inode */
96 #define EXT2_ACL_DATA_INO 4 /* ACL inode */
97 #define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
98 #define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
100 /* First non-reserved inode for old ext2 filesystems */
101 #define EXT2_GOOD_OLD_FIRST_INO 11
104 * The second extended file system magic number
106 #define EXT2_SUPER_MAGIC 0xEF53
109 * Maximal count of links to a file
111 #define EXT2_LINK_MAX 32000
114 * Note: under FreeBSD, the "user" versions of the following macros are
115 * used (and must be used) in most cases, because ((s)->u.ext2_sb.s_es is
116 * not accessible. This depends on __KERNEL__ not being defined for
117 * kernel builds under FreeBSD.
121 * Macro-instructions used to manage several block sizes
123 #define EXT2_MIN_BLOCK_SIZE 1024
124 #define EXT2_MAX_BLOCK_SIZE 4096
125 #define EXT2_MIN_BLOCK_LOG_SIZE 10
126 #if defined(__KERNEL__) || (defined(__DragonFly__) && defined(_KERNEL))
127 # define EXT2_BLOCK_SIZE(s) ((s)->s_blocksize)
129 # define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
131 #define EXT2_ACLE_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_acl_entry))
132 #define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (__u32))
134 # define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
136 # define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
140 #define EXT2_ADDR_PER_BLOCK_BITS(s) ((s)->u.ext2_sb.s_addr_per_block_bits)
141 #define EXT2_INODE_SIZE(s) ((s)->u.ext2_sb.s_inode_size)
142 #define EXT2_FIRST_INO(s) ((s)->u.ext2_sb.s_first_ino)
144 #define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
145 EXT2_GOOD_OLD_INODE_SIZE : \
147 #define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
148 EXT2_GOOD_OLD_FIRST_INO : \
152 #define EXT2_INODES_PER_BLOCK(s) ((s)->s_inodes_per_block)
153 /* Should be sizeof(struct ext2_inode): */
154 #define EXT2_INODE_SIZE 128
155 #define EXT2_FIRST_INO 11
159 * Macro-instructions used to manage fragments
161 #define EXT2_MIN_FRAG_SIZE 1024
162 #define EXT2_MAX_FRAG_SIZE 4096
163 #define EXT2_MIN_FRAG_LOG_SIZE 10
165 # define EXT2_FRAG_SIZE(s) ((s)->u.ext2_sb.s_frag_size)
166 # define EXT2_FRAGS_PER_BLOCK(s) ((s)->u.ext2_sb.s_frags_per_block)
168 # if defined(_KERNEL) && defined(__DragonFly__)
169 # define EXT2_FRAG_SIZE(s) ((s)->s_frag_size)
171 # define EXT2_FRAG_SIZE(s) (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
173 # define EXT2_FRAGS_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
179 struct ext2_acl_header /* Header of Access Control Lists */
182 __u32 aclh_file_count;
183 __u32 aclh_acle_count;
184 __u32 aclh_first_acle;
187 struct ext2_acl_entry /* Access Control List Entry */
190 __u16 acle_perms; /* Access permissions */
191 __u16 acle_type; /* Type of entry */
192 __u16 acle_tag; /* User or group identity */
194 __u32 acle_next; /* Pointer on next entry for the */
195 /* same inode or on next free entry */
199 * Structure of a blocks group descriptor
201 struct ext2_group_desc
203 __u32 bg_block_bitmap; /* Blocks bitmap block */
204 __u32 bg_inode_bitmap; /* Inodes bitmap block */
205 __u32 bg_inode_table; /* Inodes table block */
206 __u16 bg_free_blocks_count; /* Free blocks count */
207 __u16 bg_free_inodes_count; /* Free inodes count */
208 __u16 bg_used_dirs_count; /* Directories count */
210 __u32 bg_reserved[3];
214 * Macro-instructions used to manage group descriptors
217 # define EXT2_BLOCKS_PER_GROUP(s) ((s)->u.ext2_sb.s_blocks_per_group)
218 # define EXT2_DESC_PER_BLOCK(s) ((s)->u.ext2_sb.s_desc_per_block)
219 # define EXT2_INODES_PER_GROUP(s) ((s)->u.ext2_sb.s_inodes_per_group)
220 # define EXT2_DESC_PER_BLOCK_BITS(s) ((s)->u.ext2_sb.s_desc_per_block_bits)
222 # define EXT2_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
223 # define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_group_desc))
224 # define EXT2_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
228 * Constants relative to the data blocks
230 #define EXT2_NDIR_BLOCKS 12
231 #define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
232 #define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
233 #define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
234 #define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
235 #define EXT2_MAXSYMLINKLEN (EXT2_N_BLOCKS * sizeof (__u32))
240 #define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
241 #define EXT2_UNRM_FL 0x00000002 /* Undelete */
242 #define EXT2_COMPR_FL 0x00000004 /* Compress file */
243 #define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
244 #define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
245 #define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
246 #define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
247 #define EXT2_NOATIME_FL 0x00000080 /* do not update atime */
248 /* Reserved for compression usage... */
249 #define EXT2_DIRTY_FL 0x00000100
250 #define EXT2_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
251 #define EXT2_NOCOMP_FL 0x00000400 /* Don't compress */
252 #define EXT2_ECOMPR_FL 0x00000800 /* Compression error */
253 /* End compression flags --- maybe not all used */
254 #define EXT2_BTREE_FL 0x00001000 /* btree format dir */
255 #define EXT2_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
257 #define EXT2_FL_USER_VISIBLE 0x00001FFF /* User visible flags */
258 #define EXT2_FL_USER_MODIFIABLE 0x000000FF /* User modifiable flags */
263 #define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
264 #define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
265 #define EXT2_IOC_GETVERSION _IOR('v', 1, long)
266 #define EXT2_IOC_SETVERSION _IOW('v', 2, long)
269 * Only declare `struct ext2_inode' if <vfs/ufs/inode.h> hasn't made things
270 * difficult by #defining i_mode and other struct members. The details of
271 * the struct are only needed in ext2_inode_cnv.c where the ext2fs on-disk
272 * inode is converted to a ufs in-core inode.
277 * Structure of an inode on the disk
280 __u16 i_mode; /* File mode */
281 __u16 i_uid; /* Owner Uid */
282 __u32 i_size; /* Size in bytes */
283 __u32 i_atime; /* Access time */
284 __u32 i_ctime; /* Creation time */
285 __u32 i_mtime; /* Modification time */
286 __u32 i_dtime; /* Deletion Time */
287 __u16 i_gid; /* Group Id */
288 __u16 i_links_count; /* Links count */
289 __u32 i_blocks; /* Blocks count */
290 __u32 i_flags; /* File flags */
296 __u32 h_i_translator;
301 } osd1; /* OS dependent 1 */
302 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
303 __u32 i_generation; /* File version (for NFS) */
304 __u32 i_file_acl; /* File ACL */
305 __u32 i_dir_acl; /* Directory ACL */
306 __u32 i_faddr; /* Fragment address */
309 __u8 l_i_frag; /* Fragment number */
310 __u8 l_i_fsize; /* Fragment size */
312 __u32 l_i_reserved2[2];
315 __u8 h_i_frag; /* Fragment number */
316 __u8 h_i_fsize; /* Fragment size */
323 __u8 m_i_frag; /* Fragment number */
324 __u8 m_i_fsize; /* Fragment size */
326 __u32 m_i_reserved2[2];
328 } osd2; /* OS dependent 2 */
331 #define i_size_high i_dir_acl
333 #if defined(__KERNEL__) || defined(__linux__)
334 #define i_reserved1 osd1.linux1.l_i_reserved1
335 #define i_frag osd2.linux2.l_i_frag
336 #define i_fsize osd2.linux2.l_i_fsize
337 #define i_reserved2 osd2.linux2.l_i_reserved2
341 #define i_translator osd1.hurd1.h_i_translator
342 #define i_frag osd2.hurd2.h_i_frag;
343 #define i_fsize osd2.hurd2.h_i_fsize;
344 #define i_uid_high osd2.hurd2.h_i_uid_high
345 #define i_gid_high osd2.hurd2.h_i_gid_high
346 #define i_author osd2.hurd2.h_i_author
350 #define i_reserved1 osd1.masix1.m_i_reserved1
351 #define i_frag osd2.masix2.m_i_frag
352 #define i_fsize osd2.masix2.m_i_fsize
353 #define i_reserved2 osd2.masix2.m_i_reserved2
361 #define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
362 #define EXT2_ERROR_FS 0x0002 /* Errors detected */
367 #define EXT2_MOUNT_CHECK_NORMAL 0x0001 /* Do some more checks */
368 #define EXT2_MOUNT_CHECK_STRICT 0x0002 /* Do again more checks */
369 #define EXT2_MOUNT_CHECK (EXT2_MOUNT_CHECK_NORMAL | \
370 EXT2_MOUNT_CHECK_STRICT)
371 #define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
372 #define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
373 #define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
374 #define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
375 #define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
376 #define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
378 #define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
379 #define set_opt(o, opt) o |= EXT2_MOUNT_##opt
380 #define test_opt(sb, opt) ((sb)->u.ext2_sb.s_mount_opt & \
383 * Maximal mount counts between two filesystem checks
385 #define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
386 #define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
389 * Behaviour when detecting errors
391 #define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
392 #define EXT2_ERRORS_RO 2 /* Remount fs read-only */
393 #define EXT2_ERRORS_PANIC 3 /* Panic */
394 #define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
397 * Structure of the super block
399 struct ext2_super_block {
400 __u32 s_inodes_count; /* Inodes count */
401 __u32 s_blocks_count; /* Blocks count */
402 __u32 s_r_blocks_count; /* Reserved blocks count */
403 __u32 s_free_blocks_count; /* Free blocks count */
404 __u32 s_free_inodes_count; /* Free inodes count */
405 __u32 s_first_data_block; /* First Data Block */
406 __u32 s_log_block_size; /* Block size */
407 __s32 s_log_frag_size; /* Fragment size */
408 __u32 s_blocks_per_group; /* # Blocks per group */
409 __u32 s_frags_per_group; /* # Fragments per group */
410 __u32 s_inodes_per_group; /* # Inodes per group */
411 __u32 s_mtime; /* Mount time */
412 __u32 s_wtime; /* Write time */
413 __u16 s_mnt_count; /* Mount count */
414 __s16 s_max_mnt_count; /* Maximal mount count */
415 __u16 s_magic; /* Magic signature */
416 __u16 s_state; /* File system state */
417 __u16 s_errors; /* Behaviour when detecting errors */
418 __u16 s_minor_rev_level; /* minor revision level */
419 __u32 s_lastcheck; /* time of last check */
420 __u32 s_checkinterval; /* max. time between checks */
421 __u32 s_creator_os; /* OS */
422 __u32 s_rev_level; /* Revision level */
423 __u16 s_def_resuid; /* Default uid for reserved blocks */
424 __u16 s_def_resgid; /* Default gid for reserved blocks */
426 * These fields are for EXT2_DYNAMIC_REV superblocks only.
428 * Note: the difference between the compatible feature set and
429 * the incompatible feature set is that if there is a bit set
430 * in the incompatible feature set that the kernel doesn't
431 * know about, it should refuse to mount the filesystem.
433 * e2fsck's requirements are more strict; if it doesn't know
434 * about a feature in either the compatible or incompatible
435 * feature set, it must abort and not try to meddle with
436 * things it doesn't understand...
438 __u32 s_first_ino; /* First non-reserved inode */
439 __u16 s_inode_size; /* size of inode structure */
440 __u16 s_block_group_nr; /* block group # of this superblock */
441 __u32 s_feature_compat; /* compatible feature set */
442 __u32 s_feature_incompat; /* incompatible feature set */
443 __u32 s_feature_ro_compat; /* readonly-compatible feature set */
444 __u8 s_uuid[16]; /* 128-bit uuid for volume */
445 char s_volume_name[16]; /* volume name */
446 char s_last_mounted[64]; /* directory where last mounted */
447 __u32 s_algorithm_usage_bitmap; /* For compression */
449 * Performance hints. Directory preallocation should only
450 * happen if the EXT2_COMPAT_PREALLOC flag is on.
452 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
453 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
455 __u32 s_reserved[204]; /* Padding to the end of the block */
459 #define EXT2_SB(sb) (&((sb)->u.ext2_sb))
461 /* Assume that user mode programs are passing in an ext2fs superblock, not
462 * a kernel struct super_block. This will allow us to call the feature-test
463 * macros from user land. */
464 #define EXT2_SB(sb) (sb)
468 * Codes for operating systems
470 #define EXT2_OS_LINUX 0
471 #define EXT2_OS_HURD 1
472 #define EXT2_OS_MASIX 2
473 #define EXT2_OS_FREEBSD 3
474 #define EXT2_OS_LITES 4
479 #define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
480 #define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
482 #define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
483 #define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
485 #define EXT2_GOOD_OLD_INODE_SIZE 128
488 * Feature set definitions
491 #define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
492 ( EXT2_SB(sb)->s_feature_compat & (mask) )
493 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
494 ( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
495 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
496 ( EXT2_SB(sb)->s_feature_incompat & (mask) )
498 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
500 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
501 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
502 #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
504 #define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
505 #define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
507 #define EXT2_FEATURE_COMPAT_SUPP 0
508 #define EXT2_FEATURE_INCOMPAT_SUPP EXT2_FEATURE_INCOMPAT_FILETYPE
510 #define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
511 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
512 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
514 #define EXT2_FEATURE_RO_COMPAT_SUPP EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER
518 * Default values for user and/or group using reserved blocks
520 #define EXT2_DEF_RESUID 0
521 #define EXT2_DEF_RESGID 0
524 * Structure of a directory entry
526 #define EXT2_NAME_LEN 255
528 struct ext2_dir_entry {
529 __u32 inode; /* Inode number */
530 __u16 rec_len; /* Directory entry length */
531 __u16 name_len; /* Name length */
532 char name[EXT2_NAME_LEN]; /* File name */
536 * The new version of the directory entry. Since EXT2 structures are
537 * stored in intel byte order, and the name_len field could never be
538 * bigger than 255 chars, it's safe to reclaim the extra byte for the
541 struct ext2_dir_entry_2 {
542 __u32 inode; /* Inode number */
543 __u16 rec_len; /* Directory entry length */
544 __u8 name_len; /* Name length */
546 char name[EXT2_NAME_LEN]; /* File name */
550 * Ext2 directory file types. Only the low 3 bits are used. The
551 * other bits are reserved for now.
553 #define EXT2_FT_UNKNOWN 0
554 #define EXT2_FT_REG_FILE 1
555 #define EXT2_FT_DIR 2
556 #define EXT2_FT_CHRDEV 3
557 #define EXT2_FT_BLKDEV 4
558 #define EXT2_FT_FIFO 5
559 #define EXT2_FT_SOCK 6
560 #define EXT2_FT_SYMLINK 7
562 #define EXT2_FT_MAX 8
565 * EXT2_DIR_PAD defines the directory entries boundaries
567 * NOTE: It must be a multiple of 4
569 #define EXT2_DIR_PAD 4
570 #define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
571 #define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
574 #endif /* _LINUX_EXT2_FS_H */