Merge branch 'docs-next' of git://git.lwn.net/linux-2.6
[linux-2.6/next.git] / include / linux / ext3_fs.h
blob7499b36677985240f73743c9993c0ceadd16bc5b
1 /*
2 * linux/include/linux/ext3_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)
9 * from
11 * linux/include/linux/minix_fs.h
13 * Copyright (C) 1991, 1992 Linus Torvalds
16 #ifndef _LINUX_EXT3_FS_H
17 #define _LINUX_EXT3_FS_H
19 #include <linux/types.h>
20 #include <linux/magic.h>
23 * The second extended filesystem constants/structures
27 * Define EXT3FS_DEBUG to produce debug messages
29 #undef EXT3FS_DEBUG
32 * Define EXT3_RESERVATION to reserve data blocks for expanding files
34 #define EXT3_DEFAULT_RESERVE_BLOCKS 8
35 /*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
36 #define EXT3_MAX_RESERVE_BLOCKS 1027
37 #define EXT3_RESERVE_WINDOW_NOT_ALLOCATED 0
40 * Debug code
42 #ifdef EXT3FS_DEBUG
43 #define ext3_debug(f, a...) \
44 do { \
45 printk (KERN_DEBUG "EXT3-fs DEBUG (%s, %d): %s:", \
46 __FILE__, __LINE__, __func__); \
47 printk (KERN_DEBUG f, ## a); \
48 } while (0)
49 #else
50 #define ext3_debug(f, a...) do {} while (0)
51 #endif
54 * Special inodes numbers
56 #define EXT3_BAD_INO 1 /* Bad blocks inode */
57 #define EXT3_ROOT_INO 2 /* Root inode */
58 #define EXT3_BOOT_LOADER_INO 5 /* Boot loader inode */
59 #define EXT3_UNDEL_DIR_INO 6 /* Undelete directory inode */
60 #define EXT3_RESIZE_INO 7 /* Reserved group descriptors inode */
61 #define EXT3_JOURNAL_INO 8 /* Journal inode */
63 /* First non-reserved inode for old ext3 filesystems */
64 #define EXT3_GOOD_OLD_FIRST_INO 11
67 * Maximal count of links to a file
69 #define EXT3_LINK_MAX 32000
72 * Macro-instructions used to manage several block sizes
74 #define EXT3_MIN_BLOCK_SIZE 1024
75 #define EXT3_MAX_BLOCK_SIZE 65536
76 #define EXT3_MIN_BLOCK_LOG_SIZE 10
77 #ifdef __KERNEL__
78 # define EXT3_BLOCK_SIZE(s) ((s)->s_blocksize)
79 #else
80 # define EXT3_BLOCK_SIZE(s) (EXT3_MIN_BLOCK_SIZE << (s)->s_log_block_size)
81 #endif
82 #define EXT3_ADDR_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / sizeof (__u32))
83 #ifdef __KERNEL__
84 # define EXT3_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
85 #else
86 # define EXT3_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
87 #endif
88 #ifdef __KERNEL__
89 #define EXT3_ADDR_PER_BLOCK_BITS(s) (EXT3_SB(s)->s_addr_per_block_bits)
90 #define EXT3_INODE_SIZE(s) (EXT3_SB(s)->s_inode_size)
91 #define EXT3_FIRST_INO(s) (EXT3_SB(s)->s_first_ino)
92 #else
93 #define EXT3_INODE_SIZE(s) (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
94 EXT3_GOOD_OLD_INODE_SIZE : \
95 (s)->s_inode_size)
96 #define EXT3_FIRST_INO(s) (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
97 EXT3_GOOD_OLD_FIRST_INO : \
98 (s)->s_first_ino)
99 #endif
102 * Macro-instructions used to manage fragments
104 #define EXT3_MIN_FRAG_SIZE 1024
105 #define EXT3_MAX_FRAG_SIZE 4096
106 #define EXT3_MIN_FRAG_LOG_SIZE 10
107 #ifdef __KERNEL__
108 # define EXT3_FRAG_SIZE(s) (EXT3_SB(s)->s_frag_size)
109 # define EXT3_FRAGS_PER_BLOCK(s) (EXT3_SB(s)->s_frags_per_block)
110 #else
111 # define EXT3_FRAG_SIZE(s) (EXT3_MIN_FRAG_SIZE << (s)->s_log_frag_size)
112 # define EXT3_FRAGS_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / EXT3_FRAG_SIZE(s))
113 #endif
116 * Structure of a blocks group descriptor
118 struct ext3_group_desc
120 __le32 bg_block_bitmap; /* Blocks bitmap block */
121 __le32 bg_inode_bitmap; /* Inodes bitmap block */
122 __le32 bg_inode_table; /* Inodes table block */
123 __le16 bg_free_blocks_count; /* Free blocks count */
124 __le16 bg_free_inodes_count; /* Free inodes count */
125 __le16 bg_used_dirs_count; /* Directories count */
126 __u16 bg_pad;
127 __le32 bg_reserved[3];
131 * Macro-instructions used to manage group descriptors
133 #ifdef __KERNEL__
134 # define EXT3_BLOCKS_PER_GROUP(s) (EXT3_SB(s)->s_blocks_per_group)
135 # define EXT3_DESC_PER_BLOCK(s) (EXT3_SB(s)->s_desc_per_block)
136 # define EXT3_INODES_PER_GROUP(s) (EXT3_SB(s)->s_inodes_per_group)
137 # define EXT3_DESC_PER_BLOCK_BITS(s) (EXT3_SB(s)->s_desc_per_block_bits)
138 #else
139 # define EXT3_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
140 # define EXT3_DESC_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / sizeof (struct ext3_group_desc))
141 # define EXT3_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
142 #endif
145 * Constants relative to the data blocks
147 #define EXT3_NDIR_BLOCKS 12
148 #define EXT3_IND_BLOCK EXT3_NDIR_BLOCKS
149 #define EXT3_DIND_BLOCK (EXT3_IND_BLOCK + 1)
150 #define EXT3_TIND_BLOCK (EXT3_DIND_BLOCK + 1)
151 #define EXT3_N_BLOCKS (EXT3_TIND_BLOCK + 1)
154 * Inode flags
156 #define EXT3_SECRM_FL 0x00000001 /* Secure deletion */
157 #define EXT3_UNRM_FL 0x00000002 /* Undelete */
158 #define EXT3_COMPR_FL 0x00000004 /* Compress file */
159 #define EXT3_SYNC_FL 0x00000008 /* Synchronous updates */
160 #define EXT3_IMMUTABLE_FL 0x00000010 /* Immutable file */
161 #define EXT3_APPEND_FL 0x00000020 /* writes to file may only append */
162 #define EXT3_NODUMP_FL 0x00000040 /* do not dump file */
163 #define EXT3_NOATIME_FL 0x00000080 /* do not update atime */
164 /* Reserved for compression usage... */
165 #define EXT3_DIRTY_FL 0x00000100
166 #define EXT3_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
167 #define EXT3_NOCOMPR_FL 0x00000400 /* Don't compress */
168 #define EXT3_ECOMPR_FL 0x00000800 /* Compression error */
169 /* End compression flags --- maybe not all used */
170 #define EXT3_INDEX_FL 0x00001000 /* hash-indexed directory */
171 #define EXT3_IMAGIC_FL 0x00002000 /* AFS directory */
172 #define EXT3_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
173 #define EXT3_NOTAIL_FL 0x00008000 /* file tail should not be merged */
174 #define EXT3_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
175 #define EXT3_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
176 #define EXT3_RESERVED_FL 0x80000000 /* reserved for ext3 lib */
178 #define EXT3_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
179 #define EXT3_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
181 /* Flags that should be inherited by new inodes from their parent. */
182 #define EXT3_FL_INHERITED (EXT3_SECRM_FL | EXT3_UNRM_FL | EXT3_COMPR_FL |\
183 EXT3_SYNC_FL | EXT3_IMMUTABLE_FL | EXT3_APPEND_FL |\
184 EXT3_NODUMP_FL | EXT3_NOATIME_FL | EXT3_COMPRBLK_FL|\
185 EXT3_NOCOMPR_FL | EXT3_JOURNAL_DATA_FL |\
186 EXT3_NOTAIL_FL | EXT3_DIRSYNC_FL)
188 /* Flags that are appropriate for regular files (all but dir-specific ones). */
189 #define EXT3_REG_FLMASK (~(EXT3_DIRSYNC_FL | EXT3_TOPDIR_FL))
191 /* Flags that are appropriate for non-directories/regular files. */
192 #define EXT3_OTHER_FLMASK (EXT3_NODUMP_FL | EXT3_NOATIME_FL)
194 /* Mask out flags that are inappropriate for the given type of inode. */
195 static inline __u32 ext3_mask_flags(umode_t mode, __u32 flags)
197 if (S_ISDIR(mode))
198 return flags;
199 else if (S_ISREG(mode))
200 return flags & EXT3_REG_FLMASK;
201 else
202 return flags & EXT3_OTHER_FLMASK;
206 * Inode dynamic state flags
208 #define EXT3_STATE_JDATA 0x00000001 /* journaled data exists */
209 #define EXT3_STATE_NEW 0x00000002 /* inode is newly created */
210 #define EXT3_STATE_XATTR 0x00000004 /* has in-inode xattrs */
211 #define EXT3_STATE_FLUSH_ON_CLOSE 0x00000008
213 /* Used to pass group descriptor data when online resize is done */
214 struct ext3_new_group_input {
215 __u32 group; /* Group number for this data */
216 __u32 block_bitmap; /* Absolute block number of block bitmap */
217 __u32 inode_bitmap; /* Absolute block number of inode bitmap */
218 __u32 inode_table; /* Absolute block number of inode table start */
219 __u32 blocks_count; /* Total number of blocks in this group */
220 __u16 reserved_blocks; /* Number of reserved blocks in this group */
221 __u16 unused;
224 /* The struct ext3_new_group_input in kernel space, with free_blocks_count */
225 struct ext3_new_group_data {
226 __u32 group;
227 __u32 block_bitmap;
228 __u32 inode_bitmap;
229 __u32 inode_table;
230 __u32 blocks_count;
231 __u16 reserved_blocks;
232 __u16 unused;
233 __u32 free_blocks_count;
238 * ioctl commands
240 #define EXT3_IOC_GETFLAGS FS_IOC_GETFLAGS
241 #define EXT3_IOC_SETFLAGS FS_IOC_SETFLAGS
242 #define EXT3_IOC_GETVERSION _IOR('f', 3, long)
243 #define EXT3_IOC_SETVERSION _IOW('f', 4, long)
244 #define EXT3_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
245 #define EXT3_IOC_GROUP_ADD _IOW('f', 8,struct ext3_new_group_input)
246 #define EXT3_IOC_GETVERSION_OLD FS_IOC_GETVERSION
247 #define EXT3_IOC_SETVERSION_OLD FS_IOC_SETVERSION
248 #ifdef CONFIG_JBD_DEBUG
249 #define EXT3_IOC_WAIT_FOR_READONLY _IOR('f', 99, long)
250 #endif
251 #define EXT3_IOC_GETRSVSZ _IOR('f', 5, long)
252 #define EXT3_IOC_SETRSVSZ _IOW('f', 6, long)
255 * ioctl commands in 32 bit emulation
257 #define EXT3_IOC32_GETFLAGS FS_IOC32_GETFLAGS
258 #define EXT3_IOC32_SETFLAGS FS_IOC32_SETFLAGS
259 #define EXT3_IOC32_GETVERSION _IOR('f', 3, int)
260 #define EXT3_IOC32_SETVERSION _IOW('f', 4, int)
261 #define EXT3_IOC32_GETRSVSZ _IOR('f', 5, int)
262 #define EXT3_IOC32_SETRSVSZ _IOW('f', 6, int)
263 #define EXT3_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
264 #ifdef CONFIG_JBD_DEBUG
265 #define EXT3_IOC32_WAIT_FOR_READONLY _IOR('f', 99, int)
266 #endif
267 #define EXT3_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
268 #define EXT3_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
272 * Mount options
274 struct ext3_mount_options {
275 unsigned long s_mount_opt;
276 uid_t s_resuid;
277 gid_t s_resgid;
278 unsigned long s_commit_interval;
279 #ifdef CONFIG_QUOTA
280 int s_jquota_fmt;
281 char *s_qf_names[MAXQUOTAS];
282 #endif
286 * Structure of an inode on the disk
288 struct ext3_inode {
289 __le16 i_mode; /* File mode */
290 __le16 i_uid; /* Low 16 bits of Owner Uid */
291 __le32 i_size; /* Size in bytes */
292 __le32 i_atime; /* Access time */
293 __le32 i_ctime; /* Creation time */
294 __le32 i_mtime; /* Modification time */
295 __le32 i_dtime; /* Deletion Time */
296 __le16 i_gid; /* Low 16 bits of Group Id */
297 __le16 i_links_count; /* Links count */
298 __le32 i_blocks; /* Blocks count */
299 __le32 i_flags; /* File flags */
300 union {
301 struct {
302 __u32 l_i_reserved1;
303 } linux1;
304 struct {
305 __u32 h_i_translator;
306 } hurd1;
307 struct {
308 __u32 m_i_reserved1;
309 } masix1;
310 } osd1; /* OS dependent 1 */
311 __le32 i_block[EXT3_N_BLOCKS];/* Pointers to blocks */
312 __le32 i_generation; /* File version (for NFS) */
313 __le32 i_file_acl; /* File ACL */
314 __le32 i_dir_acl; /* Directory ACL */
315 __le32 i_faddr; /* Fragment address */
316 union {
317 struct {
318 __u8 l_i_frag; /* Fragment number */
319 __u8 l_i_fsize; /* Fragment size */
320 __u16 i_pad1;
321 __le16 l_i_uid_high; /* these 2 fields */
322 __le16 l_i_gid_high; /* were reserved2[0] */
323 __u32 l_i_reserved2;
324 } linux2;
325 struct {
326 __u8 h_i_frag; /* Fragment number */
327 __u8 h_i_fsize; /* Fragment size */
328 __u16 h_i_mode_high;
329 __u16 h_i_uid_high;
330 __u16 h_i_gid_high;
331 __u32 h_i_author;
332 } hurd2;
333 struct {
334 __u8 m_i_frag; /* Fragment number */
335 __u8 m_i_fsize; /* Fragment size */
336 __u16 m_pad1;
337 __u32 m_i_reserved2[2];
338 } masix2;
339 } osd2; /* OS dependent 2 */
340 __le16 i_extra_isize;
341 __le16 i_pad1;
344 #define i_size_high i_dir_acl
346 #if defined(__KERNEL__) || defined(__linux__)
347 #define i_reserved1 osd1.linux1.l_i_reserved1
348 #define i_frag osd2.linux2.l_i_frag
349 #define i_fsize osd2.linux2.l_i_fsize
350 #define i_uid_low i_uid
351 #define i_gid_low i_gid
352 #define i_uid_high osd2.linux2.l_i_uid_high
353 #define i_gid_high osd2.linux2.l_i_gid_high
354 #define i_reserved2 osd2.linux2.l_i_reserved2
356 #elif defined(__GNU__)
358 #define i_translator osd1.hurd1.h_i_translator
359 #define i_frag osd2.hurd2.h_i_frag;
360 #define i_fsize osd2.hurd2.h_i_fsize;
361 #define i_uid_high osd2.hurd2.h_i_uid_high
362 #define i_gid_high osd2.hurd2.h_i_gid_high
363 #define i_author osd2.hurd2.h_i_author
365 #elif defined(__masix__)
367 #define i_reserved1 osd1.masix1.m_i_reserved1
368 #define i_frag osd2.masix2.m_i_frag
369 #define i_fsize osd2.masix2.m_i_fsize
370 #define i_reserved2 osd2.masix2.m_i_reserved2
372 #endif /* defined(__KERNEL__) || defined(__linux__) */
375 * File system states
377 #define EXT3_VALID_FS 0x0001 /* Unmounted cleanly */
378 #define EXT3_ERROR_FS 0x0002 /* Errors detected */
379 #define EXT3_ORPHAN_FS 0x0004 /* Orphans being recovered */
382 * Misc. filesystem flags
384 #define EXT2_FLAGS_SIGNED_HASH 0x0001 /* Signed dirhash in use */
385 #define EXT2_FLAGS_UNSIGNED_HASH 0x0002 /* Unsigned dirhash in use */
386 #define EXT2_FLAGS_TEST_FILESYS 0x0004 /* to test development code */
389 * Mount flags
391 #define EXT3_MOUNT_CHECK 0x00001 /* Do mount-time checks */
392 #define EXT3_MOUNT_OLDALLOC 0x00002 /* Don't use the new Orlov allocator */
393 #define EXT3_MOUNT_GRPID 0x00004 /* Create files with directory's group */
394 #define EXT3_MOUNT_DEBUG 0x00008 /* Some debugging messages */
395 #define EXT3_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
396 #define EXT3_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
397 #define EXT3_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
398 #define EXT3_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
399 #define EXT3_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
400 #define EXT3_MOUNT_ABORT 0x00200 /* Fatal error detected */
401 #define EXT3_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
402 #define EXT3_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
403 #define EXT3_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
404 #define EXT3_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
405 #define EXT3_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
406 #define EXT3_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
407 #define EXT3_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
408 #define EXT3_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
409 #define EXT3_MOUNT_RESERVATION 0x10000 /* Preallocation */
410 #define EXT3_MOUNT_BARRIER 0x20000 /* Use block barriers */
411 #define EXT3_MOUNT_NOBH 0x40000 /* No bufferheads */
412 #define EXT3_MOUNT_QUOTA 0x80000 /* Some quota option set */
413 #define EXT3_MOUNT_USRQUOTA 0x100000 /* "old" user quota */
414 #define EXT3_MOUNT_GRPQUOTA 0x200000 /* "old" group quota */
415 #define EXT3_MOUNT_DATA_ERR_ABORT 0x400000 /* Abort on file data write
416 * error in ordered mode */
418 /* Compatibility, for having both ext2_fs.h and ext3_fs.h included at once */
419 #ifndef _LINUX_EXT2_FS_H
420 #define clear_opt(o, opt) o &= ~EXT3_MOUNT_##opt
421 #define set_opt(o, opt) o |= EXT3_MOUNT_##opt
422 #define test_opt(sb, opt) (EXT3_SB(sb)->s_mount_opt & \
423 EXT3_MOUNT_##opt)
424 #else
425 #define EXT2_MOUNT_NOLOAD EXT3_MOUNT_NOLOAD
426 #define EXT2_MOUNT_ABORT EXT3_MOUNT_ABORT
427 #define EXT2_MOUNT_DATA_FLAGS EXT3_MOUNT_DATA_FLAGS
428 #endif
430 #define ext3_set_bit ext2_set_bit
431 #define ext3_set_bit_atomic ext2_set_bit_atomic
432 #define ext3_clear_bit ext2_clear_bit
433 #define ext3_clear_bit_atomic ext2_clear_bit_atomic
434 #define ext3_test_bit ext2_test_bit
435 #define ext3_find_first_zero_bit ext2_find_first_zero_bit
436 #define ext3_find_next_zero_bit ext2_find_next_zero_bit
439 * Maximal mount counts between two filesystem checks
441 #define EXT3_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
442 #define EXT3_DFL_CHECKINTERVAL 0 /* Don't use interval check */
445 * Behaviour when detecting errors
447 #define EXT3_ERRORS_CONTINUE 1 /* Continue execution */
448 #define EXT3_ERRORS_RO 2 /* Remount fs read-only */
449 #define EXT3_ERRORS_PANIC 3 /* Panic */
450 #define EXT3_ERRORS_DEFAULT EXT3_ERRORS_CONTINUE
453 * Structure of the super block
455 struct ext3_super_block {
456 /*00*/ __le32 s_inodes_count; /* Inodes count */
457 __le32 s_blocks_count; /* Blocks count */
458 __le32 s_r_blocks_count; /* Reserved blocks count */
459 __le32 s_free_blocks_count; /* Free blocks count */
460 /*10*/ __le32 s_free_inodes_count; /* Free inodes count */
461 __le32 s_first_data_block; /* First Data Block */
462 __le32 s_log_block_size; /* Block size */
463 __le32 s_log_frag_size; /* Fragment size */
464 /*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
465 __le32 s_frags_per_group; /* # Fragments per group */
466 __le32 s_inodes_per_group; /* # Inodes per group */
467 __le32 s_mtime; /* Mount time */
468 /*30*/ __le32 s_wtime; /* Write time */
469 __le16 s_mnt_count; /* Mount count */
470 __le16 s_max_mnt_count; /* Maximal mount count */
471 __le16 s_magic; /* Magic signature */
472 __le16 s_state; /* File system state */
473 __le16 s_errors; /* Behaviour when detecting errors */
474 __le16 s_minor_rev_level; /* minor revision level */
475 /*40*/ __le32 s_lastcheck; /* time of last check */
476 __le32 s_checkinterval; /* max. time between checks */
477 __le32 s_creator_os; /* OS */
478 __le32 s_rev_level; /* Revision level */
479 /*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
480 __le16 s_def_resgid; /* Default gid for reserved blocks */
482 * These fields are for EXT3_DYNAMIC_REV superblocks only.
484 * Note: the difference between the compatible feature set and
485 * the incompatible feature set is that if there is a bit set
486 * in the incompatible feature set that the kernel doesn't
487 * know about, it should refuse to mount the filesystem.
489 * e2fsck's requirements are more strict; if it doesn't know
490 * about a feature in either the compatible or incompatible
491 * feature set, it must abort and not try to meddle with
492 * things it doesn't understand...
494 __le32 s_first_ino; /* First non-reserved inode */
495 __le16 s_inode_size; /* size of inode structure */
496 __le16 s_block_group_nr; /* block group # of this superblock */
497 __le32 s_feature_compat; /* compatible feature set */
498 /*60*/ __le32 s_feature_incompat; /* incompatible feature set */
499 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
500 /*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
501 /*78*/ char s_volume_name[16]; /* volume name */
502 /*88*/ char s_last_mounted[64]; /* directory where last mounted */
503 /*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
505 * Performance hints. Directory preallocation should only
506 * happen if the EXT3_FEATURE_COMPAT_DIR_PREALLOC flag is on.
508 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
509 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
510 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
512 * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
514 /*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
515 /*E0*/ __le32 s_journal_inum; /* inode number of journal file */
516 __le32 s_journal_dev; /* device number of journal file */
517 __le32 s_last_orphan; /* start of list of inodes to delete */
518 __le32 s_hash_seed[4]; /* HTREE hash seed */
519 __u8 s_def_hash_version; /* Default hash version to use */
520 __u8 s_reserved_char_pad;
521 __u16 s_reserved_word_pad;
522 __le32 s_default_mount_opts;
523 __le32 s_first_meta_bg; /* First metablock block group */
524 __le32 s_mkfs_time; /* When the filesystem was created */
525 __le32 s_jnl_blocks[17]; /* Backup of the journal inode */
526 /* 64bit support valid if EXT4_FEATURE_COMPAT_64BIT */
527 /*150*/ __le32 s_blocks_count_hi; /* Blocks count */
528 __le32 s_r_blocks_count_hi; /* Reserved blocks count */
529 __le32 s_free_blocks_count_hi; /* Free blocks count */
530 __le16 s_min_extra_isize; /* All inodes have at least # bytes */
531 __le16 s_want_extra_isize; /* New inodes should reserve # bytes */
532 __le32 s_flags; /* Miscellaneous flags */
533 __le16 s_raid_stride; /* RAID stride */
534 __le16 s_mmp_interval; /* # seconds to wait in MMP checking */
535 __le64 s_mmp_block; /* Block for multi-mount protection */
536 __le32 s_raid_stripe_width; /* blocks on all data disks (N*stride)*/
537 __u8 s_log_groups_per_flex; /* FLEX_BG group size */
538 __u8 s_reserved_char_pad2;
539 __le16 s_reserved_pad;
540 __u32 s_reserved[162]; /* Padding to the end of the block */
543 #ifdef __KERNEL__
544 #include <linux/ext3_fs_i.h>
545 #include <linux/ext3_fs_sb.h>
546 static inline struct ext3_sb_info * EXT3_SB(struct super_block *sb)
548 return sb->s_fs_info;
550 static inline struct ext3_inode_info *EXT3_I(struct inode *inode)
552 return container_of(inode, struct ext3_inode_info, vfs_inode);
555 static inline int ext3_valid_inum(struct super_block *sb, unsigned long ino)
557 return ino == EXT3_ROOT_INO ||
558 ino == EXT3_JOURNAL_INO ||
559 ino == EXT3_RESIZE_INO ||
560 (ino >= EXT3_FIRST_INO(sb) &&
561 ino <= le32_to_cpu(EXT3_SB(sb)->s_es->s_inodes_count));
563 #else
564 /* Assume that user mode programs are passing in an ext3fs superblock, not
565 * a kernel struct super_block. This will allow us to call the feature-test
566 * macros from user land. */
567 #define EXT3_SB(sb) (sb)
568 #endif
570 #define NEXT_ORPHAN(inode) EXT3_I(inode)->i_dtime
573 * Codes for operating systems
575 #define EXT3_OS_LINUX 0
576 #define EXT3_OS_HURD 1
577 #define EXT3_OS_MASIX 2
578 #define EXT3_OS_FREEBSD 3
579 #define EXT3_OS_LITES 4
582 * Revision levels
584 #define EXT3_GOOD_OLD_REV 0 /* The good old (original) format */
585 #define EXT3_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
587 #define EXT3_CURRENT_REV EXT3_GOOD_OLD_REV
588 #define EXT3_MAX_SUPP_REV EXT3_DYNAMIC_REV
590 #define EXT3_GOOD_OLD_INODE_SIZE 128
593 * Feature set definitions
596 #define EXT3_HAS_COMPAT_FEATURE(sb,mask) \
597 ( EXT3_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
598 #define EXT3_HAS_RO_COMPAT_FEATURE(sb,mask) \
599 ( EXT3_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
600 #define EXT3_HAS_INCOMPAT_FEATURE(sb,mask) \
601 ( EXT3_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
602 #define EXT3_SET_COMPAT_FEATURE(sb,mask) \
603 EXT3_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
604 #define EXT3_SET_RO_COMPAT_FEATURE(sb,mask) \
605 EXT3_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
606 #define EXT3_SET_INCOMPAT_FEATURE(sb,mask) \
607 EXT3_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
608 #define EXT3_CLEAR_COMPAT_FEATURE(sb,mask) \
609 EXT3_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
610 #define EXT3_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
611 EXT3_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
612 #define EXT3_CLEAR_INCOMPAT_FEATURE(sb,mask) \
613 EXT3_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
615 #define EXT3_FEATURE_COMPAT_DIR_PREALLOC 0x0001
616 #define EXT3_FEATURE_COMPAT_IMAGIC_INODES 0x0002
617 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
618 #define EXT3_FEATURE_COMPAT_EXT_ATTR 0x0008
619 #define EXT3_FEATURE_COMPAT_RESIZE_INODE 0x0010
620 #define EXT3_FEATURE_COMPAT_DIR_INDEX 0x0020
622 #define EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
623 #define EXT3_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
624 #define EXT3_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
626 #define EXT3_FEATURE_INCOMPAT_COMPRESSION 0x0001
627 #define EXT3_FEATURE_INCOMPAT_FILETYPE 0x0002
628 #define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
629 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
630 #define EXT3_FEATURE_INCOMPAT_META_BG 0x0010
632 #define EXT3_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
633 #define EXT3_FEATURE_INCOMPAT_SUPP (EXT3_FEATURE_INCOMPAT_FILETYPE| \
634 EXT3_FEATURE_INCOMPAT_RECOVER| \
635 EXT3_FEATURE_INCOMPAT_META_BG)
636 #define EXT3_FEATURE_RO_COMPAT_SUPP (EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER| \
637 EXT3_FEATURE_RO_COMPAT_LARGE_FILE| \
638 EXT3_FEATURE_RO_COMPAT_BTREE_DIR)
641 * Default values for user and/or group using reserved blocks
643 #define EXT3_DEF_RESUID 0
644 #define EXT3_DEF_RESGID 0
647 * Default mount options
649 #define EXT3_DEFM_DEBUG 0x0001
650 #define EXT3_DEFM_BSDGROUPS 0x0002
651 #define EXT3_DEFM_XATTR_USER 0x0004
652 #define EXT3_DEFM_ACL 0x0008
653 #define EXT3_DEFM_UID16 0x0010
654 #define EXT3_DEFM_JMODE 0x0060
655 #define EXT3_DEFM_JMODE_DATA 0x0020
656 #define EXT3_DEFM_JMODE_ORDERED 0x0040
657 #define EXT3_DEFM_JMODE_WBACK 0x0060
660 * Structure of a directory entry
662 #define EXT3_NAME_LEN 255
664 struct ext3_dir_entry {
665 __le32 inode; /* Inode number */
666 __le16 rec_len; /* Directory entry length */
667 __le16 name_len; /* Name length */
668 char name[EXT3_NAME_LEN]; /* File name */
672 * The new version of the directory entry. Since EXT3 structures are
673 * stored in intel byte order, and the name_len field could never be
674 * bigger than 255 chars, it's safe to reclaim the extra byte for the
675 * file_type field.
677 struct ext3_dir_entry_2 {
678 __le32 inode; /* Inode number */
679 __le16 rec_len; /* Directory entry length */
680 __u8 name_len; /* Name length */
681 __u8 file_type;
682 char name[EXT3_NAME_LEN]; /* File name */
686 * Ext3 directory file types. Only the low 3 bits are used. The
687 * other bits are reserved for now.
689 #define EXT3_FT_UNKNOWN 0
690 #define EXT3_FT_REG_FILE 1
691 #define EXT3_FT_DIR 2
692 #define EXT3_FT_CHRDEV 3
693 #define EXT3_FT_BLKDEV 4
694 #define EXT3_FT_FIFO 5
695 #define EXT3_FT_SOCK 6
696 #define EXT3_FT_SYMLINK 7
698 #define EXT3_FT_MAX 8
701 * EXT3_DIR_PAD defines the directory entries boundaries
703 * NOTE: It must be a multiple of 4
705 #define EXT3_DIR_PAD 4
706 #define EXT3_DIR_ROUND (EXT3_DIR_PAD - 1)
707 #define EXT3_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT3_DIR_ROUND) & \
708 ~EXT3_DIR_ROUND)
709 #define EXT3_MAX_REC_LEN ((1<<16)-1)
711 static inline unsigned ext3_rec_len_from_disk(__le16 dlen)
713 unsigned len = le16_to_cpu(dlen);
715 if (len == EXT3_MAX_REC_LEN)
716 return 1 << 16;
717 return len;
720 static inline __le16 ext3_rec_len_to_disk(unsigned len)
722 if (len == (1 << 16))
723 return cpu_to_le16(EXT3_MAX_REC_LEN);
724 else if (len > (1 << 16))
725 BUG();
726 return cpu_to_le16(len);
730 * Hash Tree Directory indexing
731 * (c) Daniel Phillips, 2001
734 #define is_dx(dir) (EXT3_HAS_COMPAT_FEATURE(dir->i_sb, \
735 EXT3_FEATURE_COMPAT_DIR_INDEX) && \
736 (EXT3_I(dir)->i_flags & EXT3_INDEX_FL))
737 #define EXT3_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT3_LINK_MAX)
738 #define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
740 /* Legal values for the dx_root hash_version field: */
742 #define DX_HASH_LEGACY 0
743 #define DX_HASH_HALF_MD4 1
744 #define DX_HASH_TEA 2
745 #define DX_HASH_LEGACY_UNSIGNED 3
746 #define DX_HASH_HALF_MD4_UNSIGNED 4
747 #define DX_HASH_TEA_UNSIGNED 5
749 #ifdef __KERNEL__
751 /* hash info structure used by the directory hash */
752 struct dx_hash_info
754 u32 hash;
755 u32 minor_hash;
756 int hash_version;
757 u32 *seed;
760 #define EXT3_HTREE_EOF 0x7fffffff
763 * Control parameters used by ext3_htree_next_block
765 #define HASH_NB_ALWAYS 1
769 * Describe an inode's exact location on disk and in memory
771 struct ext3_iloc
773 struct buffer_head *bh;
774 unsigned long offset;
775 unsigned long block_group;
778 static inline struct ext3_inode *ext3_raw_inode(struct ext3_iloc *iloc)
780 return (struct ext3_inode *) (iloc->bh->b_data + iloc->offset);
784 * This structure is stuffed into the struct file's private_data field
785 * for directories. It is where we put information so that we can do
786 * readdir operations in hash tree order.
788 struct dir_private_info {
789 struct rb_root root;
790 struct rb_node *curr_node;
791 struct fname *extra_fname;
792 loff_t last_pos;
793 __u32 curr_hash;
794 __u32 curr_minor_hash;
795 __u32 next_hash;
798 /* calculate the first block number of the group */
799 static inline ext3_fsblk_t
800 ext3_group_first_block_no(struct super_block *sb, unsigned long group_no)
802 return group_no * (ext3_fsblk_t)EXT3_BLOCKS_PER_GROUP(sb) +
803 le32_to_cpu(EXT3_SB(sb)->s_es->s_first_data_block);
807 * Special error return code only used by dx_probe() and its callers.
809 #define ERR_BAD_DX_DIR -75000
812 * Function prototypes
816 * Ok, these declarations are also in <linux/kernel.h> but none of the
817 * ext3 source programs needs to include it so they are duplicated here.
819 # define NORET_TYPE /**/
820 # define ATTRIB_NORET __attribute__((noreturn))
821 # define NORET_AND noreturn,
823 /* balloc.c */
824 extern int ext3_bg_has_super(struct super_block *sb, int group);
825 extern unsigned long ext3_bg_num_gdb(struct super_block *sb, int group);
826 extern ext3_fsblk_t ext3_new_block (handle_t *handle, struct inode *inode,
827 ext3_fsblk_t goal, int *errp);
828 extern ext3_fsblk_t ext3_new_blocks (handle_t *handle, struct inode *inode,
829 ext3_fsblk_t goal, unsigned long *count, int *errp);
830 extern void ext3_free_blocks (handle_t *handle, struct inode *inode,
831 ext3_fsblk_t block, unsigned long count);
832 extern void ext3_free_blocks_sb (handle_t *handle, struct super_block *sb,
833 ext3_fsblk_t block, unsigned long count,
834 unsigned long *pdquot_freed_blocks);
835 extern ext3_fsblk_t ext3_count_free_blocks (struct super_block *);
836 extern void ext3_check_blocks_bitmap (struct super_block *);
837 extern struct ext3_group_desc * ext3_get_group_desc(struct super_block * sb,
838 unsigned int block_group,
839 struct buffer_head ** bh);
840 extern int ext3_should_retry_alloc(struct super_block *sb, int *retries);
841 extern void ext3_init_block_alloc_info(struct inode *);
842 extern void ext3_rsv_window_add(struct super_block *sb, struct ext3_reserve_window_node *rsv);
844 /* dir.c */
845 extern int ext3_check_dir_entry(const char *, struct inode *,
846 struct ext3_dir_entry_2 *,
847 struct buffer_head *, unsigned long);
848 extern int ext3_htree_store_dirent(struct file *dir_file, __u32 hash,
849 __u32 minor_hash,
850 struct ext3_dir_entry_2 *dirent);
851 extern void ext3_htree_free_dir_info(struct dir_private_info *p);
853 /* fsync.c */
854 extern int ext3_sync_file (struct file *, struct dentry *, int);
856 /* hash.c */
857 extern int ext3fs_dirhash(const char *name, int len, struct
858 dx_hash_info *hinfo);
860 /* ialloc.c */
861 extern struct inode * ext3_new_inode (handle_t *, struct inode *, int);
862 extern void ext3_free_inode (handle_t *, struct inode *);
863 extern struct inode * ext3_orphan_get (struct super_block *, unsigned long);
864 extern unsigned long ext3_count_free_inodes (struct super_block *);
865 extern unsigned long ext3_count_dirs (struct super_block *);
866 extern void ext3_check_inodes_bitmap (struct super_block *);
867 extern unsigned long ext3_count_free (struct buffer_head *, unsigned);
870 /* inode.c */
871 int ext3_forget(handle_t *handle, int is_metadata, struct inode *inode,
872 struct buffer_head *bh, ext3_fsblk_t blocknr);
873 struct buffer_head * ext3_getblk (handle_t *, struct inode *, long, int, int *);
874 struct buffer_head * ext3_bread (handle_t *, struct inode *, int, int, int *);
875 int ext3_get_blocks_handle(handle_t *handle, struct inode *inode,
876 sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
877 int create);
879 extern struct inode *ext3_iget(struct super_block *, unsigned long);
880 extern int ext3_write_inode (struct inode *, int);
881 extern int ext3_setattr (struct dentry *, struct iattr *);
882 extern void ext3_delete_inode (struct inode *);
883 extern int ext3_sync_inode (handle_t *, struct inode *);
884 extern void ext3_discard_reservation (struct inode *);
885 extern void ext3_dirty_inode(struct inode *);
886 extern int ext3_change_inode_journal_flag(struct inode *, int);
887 extern int ext3_get_inode_loc(struct inode *, struct ext3_iloc *);
888 extern int ext3_can_truncate(struct inode *inode);
889 extern void ext3_truncate (struct inode *);
890 extern void ext3_set_inode_flags(struct inode *);
891 extern void ext3_get_inode_flags(struct ext3_inode_info *);
892 extern void ext3_set_aops(struct inode *inode);
893 extern int ext3_fiemap(struct inode *inode, struct fiemap_extent_info *fieinfo,
894 u64 start, u64 len);
896 /* ioctl.c */
897 extern long ext3_ioctl(struct file *, unsigned int, unsigned long);
898 extern long ext3_compat_ioctl(struct file *, unsigned int, unsigned long);
900 /* namei.c */
901 extern int ext3_orphan_add(handle_t *, struct inode *);
902 extern int ext3_orphan_del(handle_t *, struct inode *);
903 extern int ext3_htree_fill_tree(struct file *dir_file, __u32 start_hash,
904 __u32 start_minor_hash, __u32 *next_hash);
906 /* resize.c */
907 extern int ext3_group_add(struct super_block *sb,
908 struct ext3_new_group_data *input);
909 extern int ext3_group_extend(struct super_block *sb,
910 struct ext3_super_block *es,
911 ext3_fsblk_t n_blocks_count);
913 /* super.c */
914 extern void ext3_error (struct super_block *, const char *, const char *, ...)
915 __attribute__ ((format (printf, 3, 4)));
916 extern void __ext3_std_error (struct super_block *, const char *, int);
917 extern void ext3_abort (struct super_block *, const char *, const char *, ...)
918 __attribute__ ((format (printf, 3, 4)));
919 extern void ext3_warning (struct super_block *, const char *, const char *, ...)
920 __attribute__ ((format (printf, 3, 4)));
921 extern void ext3_update_dynamic_rev (struct super_block *sb);
923 #define ext3_std_error(sb, errno) \
924 do { \
925 if ((errno)) \
926 __ext3_std_error((sb), __func__, (errno)); \
927 } while (0)
930 * Inodes and files operations
933 /* dir.c */
934 extern const struct file_operations ext3_dir_operations;
936 /* file.c */
937 extern const struct inode_operations ext3_file_inode_operations;
938 extern const struct file_operations ext3_file_operations;
940 /* namei.c */
941 extern const struct inode_operations ext3_dir_inode_operations;
942 extern const struct inode_operations ext3_special_inode_operations;
944 /* symlink.c */
945 extern const struct inode_operations ext3_symlink_inode_operations;
946 extern const struct inode_operations ext3_fast_symlink_inode_operations;
949 #endif /* __KERNEL__ */
951 #endif /* _LINUX_EXT3_FS_H */