2 * This file has been copied from
3 * linux/include/linux/ext2_fs.h
5 * Copyright (C) 1992, 1993, 1994, 1995
6 * Remy Card (card@masi.ibp.fr)
7 * Laboratoire MASI - Institut Blaise Pascal
8 * Universite Pierre et Marie Curie (Paris VI)
12 * linux/include/linux/minix_fs.h
14 * Copyright (C) 1991, 1992 Linus Torvalds
20 /* from /usr/include/linux/magic.h */
22 #define EXT2_SUPER_MAGIC 0xEF53
25 * The second extended filesystem constants/structures
29 * Define EXT2FS_DEBUG to produce debug messages
34 * Define EXT2_RESERVATION to reserve data blocks for expanding files
36 #define EXT2_DEFAULT_RESERVE_BLOCKS 8
37 /*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
38 #define EXT2_MAX_RESERVE_BLOCKS 1027
39 #define EXT2_RESERVE_WINDOW_NOT_ALLOCATED 0
41 * The second extended file system version
43 #define EXT2FS_DATE "95/08/09"
44 #define EXT2FS_VERSION "0.5b"
50 # define ext2_debug(f, a...) { \
51 printk ("EXT2-fs DEBUG (%s, %d): %s:", \
52 __FILE__, __LINE__, __FUNCTION__); \
56 # define ext2_debug(f, a...) /**/
60 * Special inode numbers
62 #define EXT2_BAD_INO 1 /* Bad blocks inode */
63 #define EXT2_ROOT_INO 2 /* Root inode */
64 #define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
65 #define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
67 /* First non-reserved inode for old ext2 filesystems */
68 #define EXT2_GOOD_OLD_FIRST_INO 11
70 /* Assume that user mode programs are passing in an ext2fs superblock, not
71 * a kernel struct super_block. This will allow us to call the feature-test
72 * macros from user land. */
73 #define EXT2_SB(sb) (sb)
76 * Maximal count of links to a file
78 #define EXT2_LINK_MAX 32000
81 * Macro-instructions used to manage several block sizes
83 #define EXT2_MIN_BLOCK_SIZE 1024
84 #define EXT2_MAX_BLOCK_SIZE 4096
85 #define EXT2_MIN_BLOCK_LOG_SIZE 10
86 # define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
87 #define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (uint32_t))
88 # define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
89 #define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
90 EXT2_GOOD_OLD_INODE_SIZE : \
92 #define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
93 EXT2_GOOD_OLD_FIRST_INO : \
97 * Macro-instructions used to manage fragments
99 #define EXT2_MIN_FRAG_SIZE 1024
100 #define EXT2_MAX_FRAG_SIZE 4096
101 #define EXT2_MIN_FRAG_LOG_SIZE 10
102 # define EXT2_FRAG_SIZE(s) (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
103 # define EXT2_FRAGS_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
106 * Structure of a blocks group descriptor
108 struct ext2_group_desc
110 uint32_t bg_block_bitmap; /* Blocks bitmap block */
111 uint32_t bg_inode_bitmap; /* Inodes bitmap block */
112 uint32_t bg_inode_table; /* Inodes table block */
113 uint16_t bg_free_blocks_count; /* Free blocks count */
114 uint16_t bg_free_inodes_count; /* Free inodes count */
115 uint16_t bg_used_dirs_count; /* Directories count */
117 uint32_t bg_reserved[3];
121 * Macro-instructions used to manage group descriptors
123 # define EXT2_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
124 # define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_group_desc))
125 # define EXT2_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
128 * Constants relative to the data blocks
130 #define EXT2_NDIR_BLOCKS 12
131 #define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
132 #define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
133 #define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
134 #define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
137 * Inode flags (GETFLAGS/SETFLAGS)
139 #define EXT2_SECRM_FL FS_SECRM_FL /* Secure deletion */
140 #define EXT2_UNRM_FL FS_UNRM_FL /* Undelete */
141 #define EXT2_COMPR_FL FS_COMPR_FL /* Compress file */
142 #define EXT2_SYNC_FL FS_SYNC_FL /* Synchronous updates */
143 #define EXT2_IMMUTABLE_FL FS_IMMUTABLE_FL /* Immutable file */
144 #define EXT2_APPEND_FL FS_APPEND_FL /* writes to file may only append */
145 #define EXT2_NODUMP_FL FS_NODUMP_FL /* do not dump file */
146 #define EXT2_NOATIME_FL FS_NOATIME_FL /* do not update atime */
147 /* Reserved for compression usage... */
148 #define EXT2_DIRTY_FL FS_DIRTY_FL
149 #define EXT2_COMPRBLK_FL FS_COMPRBLK_FL /* One or more compressed clusters */
150 #define EXT2_NOCOMP_FL FS_NOCOMP_FL /* Don't compress */
151 #define EXT2_ECOMPR_FL FS_ECOMPR_FL /* Compression error */
152 /* End compression flags --- maybe not all used */
153 #define EXT2_BTREE_FL FS_BTREE_FL /* btree format dir */
154 #define EXT2_INDEX_FL FS_INDEX_FL /* hash-indexed directory */
155 #define EXT2_IMAGIC_FL FS_IMAGIC_FL /* AFS directory */
156 #define EXT2_JOURNAL_DATA_FL FS_JOURNAL_DATA_FL /* Reserved for ext3 */
157 #define EXT2_NOTAIL_FL FS_NOTAIL_FL /* file tail should not be merged */
158 #define EXT2_DIRSYNC_FL FS_DIRSYNC_FL /* dirsync behaviour (directories only) */
159 #define EXT2_TOPDIR_FL FS_TOPDIR_FL /* Top of directory hierarchies*/
160 #define EXT2_RESERVED_FL FS_RESERVED_FL /* reserved for ext2 lib */
162 #define EXT2_FL_USER_VISIBLE FS_FL_USER_VISIBLE /* User visible flags */
163 #define EXT2_FL_USER_MODIFIABLE FS_FL_USER_MODIFIABLE /* User modifiable flags */
168 #define EXT2_IOC_GETFLAGS FS_IOC_GETFLAGS
169 #define EXT2_IOC_SETFLAGS FS_IOC_SETFLAGS
170 #define EXT2_IOC_GETVERSION FS_IOC_GETVERSION
171 #define EXT2_IOC_SETVERSION FS_IOC_SETVERSION
172 #define EXT2_IOC_GETRSVSZ _IOR('f', 5, long)
173 #define EXT2_IOC_SETRSVSZ _IOW('f', 6, long)
176 * ioctl commands in 32 bit emulation
178 #define EXT2_IOC32_GETFLAGS FS_IOC32_GETFLAGS
179 #define EXT2_IOC32_SETFLAGS FS_IOC32_SETFLAGS
180 #define EXT2_IOC32_GETVERSION FS_IOC32_GETVERSION
181 #define EXT2_IOC32_SETVERSION FS_IOC32_SETVERSION
184 * Structure of an inode on the disk
187 uint16_t i_mode; /* File mode */
188 uint16_t i_uid; /* Low 16 bits of Owner Uid */
189 uint32_t i_size; /* Size in bytes */
190 uint32_t i_atime; /* Access time */
191 uint32_t i_ctime; /* Creation time */
192 uint32_t i_mtime; /* Modification time */
193 uint32_t i_dtime; /* Deletion Time */
194 uint16_t i_gid; /* Low 16 bits of Group Id */
195 uint16_t i_links_count; /* Links count */
196 uint32_t i_blocks; /* Blocks count */
197 uint32_t i_flags; /* File flags */
200 uint32_t l_i_reserved1;
203 uint32_t h_i_translator;
206 uint32_t m_i_reserved1;
208 } osd1; /* OS dependent 1 */
209 uint32_t i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
210 uint32_t i_generation; /* File version (for NFS) */
211 uint32_t i_file_acl; /* File ACL */
212 uint32_t i_dir_acl; /* Directory ACL */
213 uint32_t i_faddr; /* Fragment address */
216 uint8_t l_i_frag; /* Fragment number */
217 uint8_t l_i_fsize; /* Fragment size */
219 uint16_t l_i_uid_high; /* these 2 fields */
220 uint16_t l_i_gid_high; /* were reserved2[0] */
221 uint32_t l_i_reserved2;
224 uint8_t h_i_frag; /* Fragment number */
225 uint8_t h_i_fsize; /* Fragment size */
226 uint16_t h_i_mode_high;
227 uint16_t h_i_uid_high;
228 uint16_t h_i_gid_high;
232 uint8_t m_i_frag; /* Fragment number */
233 uint8_t m_i_fsize; /* Fragment size */
235 uint32_t m_i_reserved2[2];
237 } osd2; /* OS dependent 2 */
240 #define i_size_high i_dir_acl
242 #if defined(__KERNEL__) || defined(__linux__)
243 #define i_reserved1 osd1.linux1.l_i_reserved1
244 #define i_frag osd2.linux2.l_i_frag
245 #define i_fsize osd2.linux2.l_i_fsize
246 #define i_uid_low i_uid
247 #define i_gid_low i_gid
248 #define i_uid_high osd2.linux2.l_i_uid_high
249 #define i_gid_high osd2.linux2.l_i_gid_high
250 #define i_reserved2 osd2.linux2.l_i_reserved2
254 #define i_translator osd1.hurd1.h_i_translator
255 #define i_frag osd2.hurd2.h_i_frag;
256 #define i_fsize osd2.hurd2.h_i_fsize;
257 #define i_uid_high osd2.hurd2.h_i_uid_high
258 #define i_gid_high osd2.hurd2.h_i_gid_high
259 #define i_author osd2.hurd2.h_i_author
263 #define i_reserved1 osd1.masix1.m_i_reserved1
264 #define i_frag osd2.masix2.m_i_frag
265 #define i_fsize osd2.masix2.m_i_fsize
266 #define i_reserved2 osd2.masix2.m_i_reserved2
272 #define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
273 #define EXT2_ERROR_FS 0x0002 /* Errors detected */
278 #define EXT2_MOUNT_CHECK 0x000001 /* Do mount-time checks */
279 #define EXT2_MOUNT_OLDALLOC 0x000002 /* Don't use the new Orlov allocator */
280 #define EXT2_MOUNT_GRPID 0x000004 /* Create files with directory's group */
281 #define EXT2_MOUNT_DEBUG 0x000008 /* Some debugging messages */
282 #define EXT2_MOUNT_ERRORS_CONT 0x000010 /* Continue on errors */
283 #define EXT2_MOUNT_ERRORS_RO 0x000020 /* Remount fs ro on errors */
284 #define EXT2_MOUNT_ERRORS_PANIC 0x000040 /* Panic on errors */
285 #define EXT2_MOUNT_MINIX_DF 0x000080 /* Mimics the Minix statfs */
286 #define EXT2_MOUNT_NOBH 0x000100 /* No buffer_heads */
287 #define EXT2_MOUNT_NO_UID32 0x000200 /* Disable 32-bit UIDs */
288 #define EXT2_MOUNT_XATTR_USER 0x004000 /* Extended user attributes */
289 #define EXT2_MOUNT_POSIX_ACL 0x008000 /* POSIX Access Control Lists */
290 #define EXT2_MOUNT_XIP 0x010000 /* Execute in place */
291 #define EXT2_MOUNT_USRQUOTA 0x020000 /* user quota */
292 #define EXT2_MOUNT_GRPQUOTA 0x040000 /* group quota */
293 #define EXT2_MOUNT_RESERVATION 0x080000 /* Preallocation */
296 #define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
297 #define set_opt(o, opt) o |= EXT2_MOUNT_##opt
298 #define test_opt(sb, opt) (EXT2_SB(sb)->s_mount_opt & \
301 * Maximal mount counts between two filesystem checks
303 #define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
304 #define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
307 * Behaviour when detecting errors
309 #define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
310 #define EXT2_ERRORS_RO 2 /* Remount fs read-only */
311 #define EXT2_ERRORS_PANIC 3 /* Panic */
312 #define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
315 * Structure of the super block
317 struct ext2_super_block {
318 uint32_t s_inodes_count; /* Inodes count */
319 uint32_t s_blocks_count; /* Blocks count */
320 uint32_t s_r_blocks_count; /* Reserved blocks count */
321 uint32_t s_free_blocks_count; /* Free blocks count */
322 uint32_t s_free_inodes_count; /* Free inodes count */
323 uint32_t s_first_data_block; /* First Data Block */
324 uint32_t s_log_block_size; /* Block size */
325 uint32_t s_log_frag_size; /* Fragment size */
326 uint32_t s_blocks_per_group; /* # Blocks per group */
327 uint32_t s_frags_per_group; /* # Fragments per group */
328 uint32_t s_inodes_per_group; /* # Inodes per group */
329 uint32_t s_mtime; /* Mount time */
330 uint32_t s_wtime; /* Write time */
331 uint16_t s_mnt_count; /* Mount count */
332 uint16_t s_max_mnt_count; /* Maximal mount count */
333 uint16_t s_magic; /* Magic signature */
334 uint16_t s_state; /* File system state */
335 uint16_t s_errors; /* Behaviour when detecting errors */
336 uint16_t s_minor_rev_level; /* minor revision level */
337 uint32_t s_lastcheck; /* time of last check */
338 uint32_t s_checkinterval; /* max. time between checks */
339 uint32_t s_creator_os; /* OS */
340 uint32_t s_rev_level; /* Revision level */
341 uint16_t s_def_resuid; /* Default uid for reserved blocks */
342 uint16_t s_def_resgid; /* Default gid for reserved blocks */
344 * These fields are for EXT2_DYNAMIC_REV superblocks only.
346 * Note: the difference between the compatible feature set and
347 * the incompatible feature set is that if there is a bit set
348 * in the incompatible feature set that the kernel doesn't
349 * know about, it should refuse to mount the filesystem.
351 * e2fsck's requirements are more strict; if it doesn't know
352 * about a feature in either the compatible or incompatible
353 * feature set, it must abort and not try to meddle with
354 * things it doesn't understand...
356 uint32_t s_first_ino; /* First non-reserved inode */
357 uint16_t s_inode_size; /* size of inode structure */
358 uint16_t s_block_group_nr; /* block group # of this superblock */
359 uint32_t s_feature_compat; /* compatible feature set */
360 uint32_t s_feature_incompat; /* incompatible feature set */
361 uint32_t s_feature_ro_compat; /* readonly-compatible feature set */
362 uint8_t s_uuid[16]; /* 128-bit uuid for volume */
363 char s_volume_name[16]; /* volume name */
364 char s_last_mounted[64]; /* directory where last mounted */
365 uint32_t s_algorithm_usage_bitmap; /* For compression */
367 * Performance hints. Directory preallocation should only
368 * happen if the EXT2_COMPAT_PREALLOC flag is on.
370 uint8_t s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
371 uint8_t s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
374 * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
376 uint8_t s_journal_uuid[16]; /* uuid of journal superblock */
377 uint32_t s_journal_inum; /* inode number of journal file */
378 uint32_t s_journal_dev; /* device number of journal file */
379 uint32_t s_last_orphan; /* start of list of inodes to delete */
380 uint32_t s_hash_seed[4]; /* HTREE hash seed */
381 uint8_t s_def_hash_version; /* Default hash version to use */
382 uint8_t s_reserved_char_pad;
383 uint16_t s_reserved_word_pad;
384 uint32_t s_default_mount_opts;
385 uint32_t s_first_meta_bg; /* First metablock block group */
386 uint32_t s_reserved[190]; /* Padding to the end of the block */
390 * Codes for operating systems
392 #define EXT2_OS_LINUX 0
393 #define EXT2_OS_HURD 1
394 #define EXT2_OS_MASIX 2
395 #define EXT2_OS_FREEBSD 3
396 #define EXT2_OS_LITES 4
401 #define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
402 #define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
404 #define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
405 #define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
407 #define EXT2_GOOD_OLD_INODE_SIZE 128
410 * Feature set definitions
413 #define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
414 ( EXT2_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
415 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
416 ( EXT2_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
417 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
418 ( EXT2_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
419 #define EXT2_SET_COMPAT_FEATURE(sb,mask) \
420 EXT2_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
421 #define EXT2_SET_RO_COMPAT_FEATURE(sb,mask) \
422 EXT2_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
423 #define EXT2_SET_INCOMPAT_FEATURE(sb,mask) \
424 EXT2_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
425 #define EXT2_CLEAR_COMPAT_FEATURE(sb,mask) \
426 EXT2_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
427 #define EXT2_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
428 EXT2_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
429 #define EXT2_CLEAR_INCOMPAT_FEATURE(sb,mask) \
430 EXT2_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
432 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
433 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES 0x0002
434 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
435 #define EXT2_FEATURE_COMPAT_EXT_ATTR 0x0008
436 #define EXT2_FEATURE_COMPAT_RESIZE_INO 0x0010
437 #define EXT2_FEATURE_COMPAT_DIR_INDEX 0x0020
438 #define EXT2_FEATURE_COMPAT_ANY 0xffffffff
440 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
441 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
442 #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
443 #define EXT2_FEATURE_RO_COMPAT_ANY 0xffffffff
445 #define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
446 #define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
447 #define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004
448 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008
449 #define EXT2_FEATURE_INCOMPAT_META_BG 0x0010
450 #define EXT2_FEATURE_INCOMPAT_ANY 0xffffffff
452 #define EXT2_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
453 #define EXT2_FEATURE_INCOMPAT_SUPP (EXT2_FEATURE_INCOMPAT_FILETYPE| \
454 EXT2_FEATURE_INCOMPAT_META_BG)
455 #define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
456 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
457 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
458 #define EXT2_FEATURE_RO_COMPAT_UNSUPPORTED ~EXT2_FEATURE_RO_COMPAT_SUPP
459 #define EXT2_FEATURE_INCOMPAT_UNSUPPORTED ~EXT2_FEATURE_INCOMPAT_SUPP
462 * Default values for user and/or group using reserved blocks
464 #define EXT2_DEF_RESUID 0
465 #define EXT2_DEF_RESGID 0
468 * Default mount options
470 #define EXT2_DEFM_DEBUG 0x0001
471 #define EXT2_DEFM_BSDGROUPS 0x0002
472 #define EXT2_DEFM_XATTR_USER 0x0004
473 #define EXT2_DEFM_ACL 0x0008
474 #define EXT2_DEFM_UID16 0x0010
475 /* Not used by ext2, but reserved for use by ext3 */
476 #define EXT3_DEFM_JMODE 0x0060
477 #define EXT3_DEFM_JMODE_DATA 0x0020
478 #define EXT3_DEFM_JMODE_ORDERED 0x0040
479 #define EXT3_DEFM_JMODE_WBACK 0x0060
482 * Structure of a directory entry
484 #define EXT2_NAME_LEN 255
486 struct ext2_dir_entry {
487 uint32_t inode; /* Inode number */
488 uint16_t rec_len; /* Directory entry length */
489 uint16_t name_len; /* Name length */
490 char name[EXT2_NAME_LEN]; /* File name */
494 * The new version of the directory entry. Since EXT2 structures are
495 * stored in intel byte order, and the name_len field could never be
496 * bigger than 255 chars, it's safe to reclaim the extra byte for the
499 struct ext2_dir_entry_2 {
500 uint32_t inode; /* Inode number */
501 uint16_t rec_len; /* Directory entry length */
502 uint8_t name_len; /* Name length */
504 char name[EXT2_NAME_LEN]; /* File name */
508 * Ext2 directory file types. Only the low 3 bits are used. The
509 * other bits are reserved for now.
524 * EXT2_DIR_PAD defines the directory entries boundaries
526 * NOTE: It must be a multiple of 4
528 #define EXT2_DIR_PAD 4
529 #define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
530 #define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
532 #define EXT2_MAX_REC_LEN ((1<<16)-1)
534 #endif /* _EXT2_FS_H */