blob: ece49a804fe18485bfdc5e1e4672c0a7f9bf0002 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * linux/include/linux/ext3_fs.h
3 *
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)
8 *
9 * from
10 *
11 * linux/include/linux/minix_fs.h
12 *
13 * Copyright (C) 1991, 1992 Linus Torvalds
14 */
15
16#ifndef _LINUX_EXT3_FS_H
17#define _LINUX_EXT3_FS_H
18
19#include <linux/types.h>
Jeff Garzike18fa702006-09-24 11:13:19 -040020#include <linux/magic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
22/*
23 * The second extended filesystem constants/structures
24 */
25
26/*
27 * Define EXT3FS_DEBUG to produce debug messages
28 */
29#undef EXT3FS_DEBUG
30
31/*
32 * Define EXT3_RESERVATION to reserve data blocks for expanding files
33 */
34#define EXT3_DEFAULT_RESERVE_BLOCKS 8
Mingming Caob54e41e2006-03-26 01:37:57 -080035/*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
36#define EXT3_MAX_RESERVE_BLOCKS 1027
Linus Torvalds1da177e2005-04-16 15:20:36 -070037#define EXT3_RESERVE_WINDOW_NOT_ALLOCATED 0
38/*
39 * Always enable hashed directories
40 */
41#define CONFIG_EXT3_INDEX
42
43/*
44 * Debug code
45 */
46#ifdef EXT3FS_DEBUG
47#define ext3_debug(f, a...) \
48 do { \
49 printk (KERN_DEBUG "EXT3-fs DEBUG (%s, %d): %s:", \
50 __FILE__, __LINE__, __FUNCTION__); \
51 printk (KERN_DEBUG f, ## a); \
52 } while (0)
53#else
54#define ext3_debug(f, a...) do {} while (0)
55#endif
56
57/*
58 * Special inodes numbers
59 */
60#define EXT3_BAD_INO 1 /* Bad blocks inode */
61#define EXT3_ROOT_INO 2 /* Root inode */
62#define EXT3_BOOT_LOADER_INO 5 /* Boot loader inode */
63#define EXT3_UNDEL_DIR_INO 6 /* Undelete directory inode */
64#define EXT3_RESIZE_INO 7 /* Reserved group descriptors inode */
65#define EXT3_JOURNAL_INO 8 /* Journal inode */
66
67/* First non-reserved inode for old ext3 filesystems */
68#define EXT3_GOOD_OLD_FIRST_INO 11
69
70/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 * Maximal count of links to a file
72 */
73#define EXT3_LINK_MAX 32000
74
75/*
76 * Macro-instructions used to manage several block sizes
77 */
78#define EXT3_MIN_BLOCK_SIZE 1024
79#define EXT3_MAX_BLOCK_SIZE 4096
80#define EXT3_MIN_BLOCK_LOG_SIZE 10
81#ifdef __KERNEL__
82# define EXT3_BLOCK_SIZE(s) ((s)->s_blocksize)
83#else
84# define EXT3_BLOCK_SIZE(s) (EXT3_MIN_BLOCK_SIZE << (s)->s_log_block_size)
85#endif
86#define EXT3_ADDR_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / sizeof (__u32))
87#ifdef __KERNEL__
88# define EXT3_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
89#else
90# define EXT3_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
91#endif
92#ifdef __KERNEL__
93#define EXT3_ADDR_PER_BLOCK_BITS(s) (EXT3_SB(s)->s_addr_per_block_bits)
94#define EXT3_INODE_SIZE(s) (EXT3_SB(s)->s_inode_size)
95#define EXT3_FIRST_INO(s) (EXT3_SB(s)->s_first_ino)
96#else
97#define EXT3_INODE_SIZE(s) (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
98 EXT3_GOOD_OLD_INODE_SIZE : \
99 (s)->s_inode_size)
100#define EXT3_FIRST_INO(s) (((s)->s_rev_level == EXT3_GOOD_OLD_REV) ? \
101 EXT3_GOOD_OLD_FIRST_INO : \
102 (s)->s_first_ino)
103#endif
104
105/*
106 * Macro-instructions used to manage fragments
107 */
108#define EXT3_MIN_FRAG_SIZE 1024
109#define EXT3_MAX_FRAG_SIZE 4096
110#define EXT3_MIN_FRAG_LOG_SIZE 10
111#ifdef __KERNEL__
112# define EXT3_FRAG_SIZE(s) (EXT3_SB(s)->s_frag_size)
113# define EXT3_FRAGS_PER_BLOCK(s) (EXT3_SB(s)->s_frags_per_block)
114#else
115# define EXT3_FRAG_SIZE(s) (EXT3_MIN_FRAG_SIZE << (s)->s_log_frag_size)
116# define EXT3_FRAGS_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / EXT3_FRAG_SIZE(s))
117#endif
118
119/*
120 * Structure of a blocks group descriptor
121 */
122struct ext3_group_desc
123{
124 __le32 bg_block_bitmap; /* Blocks bitmap block */
125 __le32 bg_inode_bitmap; /* Inodes bitmap block */
126 __le32 bg_inode_table; /* Inodes table block */
127 __le16 bg_free_blocks_count; /* Free blocks count */
128 __le16 bg_free_inodes_count; /* Free inodes count */
129 __le16 bg_used_dirs_count; /* Directories count */
130 __u16 bg_pad;
131 __le32 bg_reserved[3];
132};
133
134/*
135 * Macro-instructions used to manage group descriptors
136 */
137#ifdef __KERNEL__
138# define EXT3_BLOCKS_PER_GROUP(s) (EXT3_SB(s)->s_blocks_per_group)
139# define EXT3_DESC_PER_BLOCK(s) (EXT3_SB(s)->s_desc_per_block)
140# define EXT3_INODES_PER_GROUP(s) (EXT3_SB(s)->s_inodes_per_group)
141# define EXT3_DESC_PER_BLOCK_BITS(s) (EXT3_SB(s)->s_desc_per_block_bits)
142#else
143# define EXT3_BLOCKS_PER_GROUP(s) ((s)->s_blocks_per_group)
144# define EXT3_DESC_PER_BLOCK(s) (EXT3_BLOCK_SIZE(s) / sizeof (struct ext3_group_desc))
145# define EXT3_INODES_PER_GROUP(s) ((s)->s_inodes_per_group)
146#endif
147
148/*
149 * Constants relative to the data blocks
150 */
151#define EXT3_NDIR_BLOCKS 12
152#define EXT3_IND_BLOCK EXT3_NDIR_BLOCKS
153#define EXT3_DIND_BLOCK (EXT3_IND_BLOCK + 1)
154#define EXT3_TIND_BLOCK (EXT3_DIND_BLOCK + 1)
155#define EXT3_N_BLOCKS (EXT3_TIND_BLOCK + 1)
156
157/*
158 * Inode flags
159 */
160#define EXT3_SECRM_FL 0x00000001 /* Secure deletion */
161#define EXT3_UNRM_FL 0x00000002 /* Undelete */
162#define EXT3_COMPR_FL 0x00000004 /* Compress file */
163#define EXT3_SYNC_FL 0x00000008 /* Synchronous updates */
164#define EXT3_IMMUTABLE_FL 0x00000010 /* Immutable file */
165#define EXT3_APPEND_FL 0x00000020 /* writes to file may only append */
166#define EXT3_NODUMP_FL 0x00000040 /* do not dump file */
167#define EXT3_NOATIME_FL 0x00000080 /* do not update atime */
168/* Reserved for compression usage... */
169#define EXT3_DIRTY_FL 0x00000100
170#define EXT3_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
171#define EXT3_NOCOMPR_FL 0x00000400 /* Don't compress */
172#define EXT3_ECOMPR_FL 0x00000800 /* Compression error */
173/* End compression flags --- maybe not all used */
174#define EXT3_INDEX_FL 0x00001000 /* hash-indexed directory */
175#define EXT3_IMAGIC_FL 0x00002000 /* AFS directory */
176#define EXT3_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
177#define EXT3_NOTAIL_FL 0x00008000 /* file tail should not be merged */
178#define EXT3_DIRSYNC_FL 0x00010000 /* dirsync behaviour (directories only) */
179#define EXT3_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
180#define EXT3_RESERVED_FL 0x80000000 /* reserved for ext3 lib */
181
182#define EXT3_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
183#define EXT3_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */
184
185/*
186 * Inode dynamic state flags
187 */
188#define EXT3_STATE_JDATA 0x00000001 /* journaled data exists */
189#define EXT3_STATE_NEW 0x00000002 /* inode is newly created */
190#define EXT3_STATE_XATTR 0x00000004 /* has in-inode xattrs */
191
192/* Used to pass group descriptor data when online resize is done */
193struct ext3_new_group_input {
194 __u32 group; /* Group number for this data */
195 __u32 block_bitmap; /* Absolute block number of block bitmap */
196 __u32 inode_bitmap; /* Absolute block number of inode bitmap */
197 __u32 inode_table; /* Absolute block number of inode table start */
198 __u32 blocks_count; /* Total number of blocks in this group */
199 __u16 reserved_blocks; /* Number of reserved blocks in this group */
200 __u16 unused;
201};
202
203/* The struct ext3_new_group_input in kernel space, with free_blocks_count */
204struct ext3_new_group_data {
205 __u32 group;
206 __u32 block_bitmap;
207 __u32 inode_bitmap;
208 __u32 inode_table;
209 __u32 blocks_count;
210 __u16 reserved_blocks;
211 __u16 unused;
212 __u32 free_blocks_count;
213};
214
215
216/*
217 * ioctl commands
218 */
David Howells36695672006-08-29 19:06:16 +0100219#define EXT3_IOC_GETFLAGS FS_IOC_GETFLAGS
220#define EXT3_IOC_SETFLAGS FS_IOC_SETFLAGS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221#define EXT3_IOC_GETVERSION _IOR('f', 3, long)
222#define EXT3_IOC_SETVERSION _IOW('f', 4, long)
223#define EXT3_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
224#define EXT3_IOC_GROUP_ADD _IOW('f', 8,struct ext3_new_group_input)
David Howells36695672006-08-29 19:06:16 +0100225#define EXT3_IOC_GETVERSION_OLD FS_IOC_GETVERSION
226#define EXT3_IOC_SETVERSION_OLD FS_IOC_SETVERSION
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227#ifdef CONFIG_JBD_DEBUG
228#define EXT3_IOC_WAIT_FOR_READONLY _IOR('f', 99, long)
229#endif
230#define EXT3_IOC_GETRSVSZ _IOR('f', 5, long)
231#define EXT3_IOC_SETRSVSZ _IOW('f', 6, long)
232
233/*
David Howells36695672006-08-29 19:06:16 +0100234 * ioctl commands in 32 bit emulation
235 */
David Howells52a700c2006-08-29 19:06:23 +0100236#define EXT3_IOC32_GETFLAGS FS_IOC32_GETFLAGS
237#define EXT3_IOC32_SETFLAGS FS_IOC32_SETFLAGS
David Howells36695672006-08-29 19:06:16 +0100238#define EXT3_IOC32_GETVERSION _IOR('f', 3, int)
239#define EXT3_IOC32_SETVERSION _IOW('f', 4, int)
240#define EXT3_IOC32_GETRSVSZ _IOR('f', 5, int)
241#define EXT3_IOC32_SETRSVSZ _IOW('f', 6, int)
242#define EXT3_IOC32_GROUP_EXTEND _IOW('f', 7, unsigned int)
243#ifdef CONFIG_JBD_DEBUG
244#define EXT3_IOC32_WAIT_FOR_READONLY _IOR('f', 99, int)
245#endif
David Howells52a700c2006-08-29 19:06:23 +0100246#define EXT3_IOC32_GETVERSION_OLD FS_IOC32_GETVERSION
247#define EXT3_IOC32_SETVERSION_OLD FS_IOC32_SETVERSION
248
David Howells36695672006-08-29 19:06:16 +0100249
250/*
Jan Kara08c6a962005-07-12 13:58:28 -0700251 * Mount options
252 */
253struct ext3_mount_options {
254 unsigned long s_mount_opt;
255 uid_t s_resuid;
256 gid_t s_resgid;
257 unsigned long s_commit_interval;
258#ifdef CONFIG_QUOTA
259 int s_jquota_fmt;
260 char *s_qf_names[MAXQUOTAS];
261#endif
262};
263
264/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 * Structure of an inode on the disk
266 */
267struct ext3_inode {
268 __le16 i_mode; /* File mode */
269 __le16 i_uid; /* Low 16 bits of Owner Uid */
270 __le32 i_size; /* Size in bytes */
271 __le32 i_atime; /* Access time */
272 __le32 i_ctime; /* Creation time */
273 __le32 i_mtime; /* Modification time */
274 __le32 i_dtime; /* Deletion Time */
275 __le16 i_gid; /* Low 16 bits of Group Id */
276 __le16 i_links_count; /* Links count */
277 __le32 i_blocks; /* Blocks count */
278 __le32 i_flags; /* File flags */
279 union {
280 struct {
281 __u32 l_i_reserved1;
282 } linux1;
283 struct {
284 __u32 h_i_translator;
285 } hurd1;
286 struct {
287 __u32 m_i_reserved1;
288 } masix1;
289 } osd1; /* OS dependent 1 */
290 __le32 i_block[EXT3_N_BLOCKS];/* Pointers to blocks */
291 __le32 i_generation; /* File version (for NFS) */
292 __le32 i_file_acl; /* File ACL */
293 __le32 i_dir_acl; /* Directory ACL */
294 __le32 i_faddr; /* Fragment address */
295 union {
296 struct {
297 __u8 l_i_frag; /* Fragment number */
298 __u8 l_i_fsize; /* Fragment size */
299 __u16 i_pad1;
300 __le16 l_i_uid_high; /* these 2 fields */
301 __le16 l_i_gid_high; /* were reserved2[0] */
302 __u32 l_i_reserved2;
303 } linux2;
304 struct {
305 __u8 h_i_frag; /* Fragment number */
306 __u8 h_i_fsize; /* Fragment size */
307 __u16 h_i_mode_high;
308 __u16 h_i_uid_high;
309 __u16 h_i_gid_high;
310 __u32 h_i_author;
311 } hurd2;
312 struct {
313 __u8 m_i_frag; /* Fragment number */
314 __u8 m_i_fsize; /* Fragment size */
315 __u16 m_pad1;
316 __u32 m_i_reserved2[2];
317 } masix2;
318 } osd2; /* OS dependent 2 */
319 __le16 i_extra_isize;
320 __le16 i_pad1;
321};
322
323#define i_size_high i_dir_acl
324
325#if defined(__KERNEL__) || defined(__linux__)
326#define i_reserved1 osd1.linux1.l_i_reserved1
327#define i_frag osd2.linux2.l_i_frag
328#define i_fsize osd2.linux2.l_i_fsize
329#define i_uid_low i_uid
330#define i_gid_low i_gid
331#define i_uid_high osd2.linux2.l_i_uid_high
332#define i_gid_high osd2.linux2.l_i_gid_high
333#define i_reserved2 osd2.linux2.l_i_reserved2
334
335#elif defined(__GNU__)
336
337#define i_translator osd1.hurd1.h_i_translator
338#define i_frag osd2.hurd2.h_i_frag;
339#define i_fsize osd2.hurd2.h_i_fsize;
340#define i_uid_high osd2.hurd2.h_i_uid_high
341#define i_gid_high osd2.hurd2.h_i_gid_high
342#define i_author osd2.hurd2.h_i_author
343
344#elif defined(__masix__)
345
346#define i_reserved1 osd1.masix1.m_i_reserved1
347#define i_frag osd2.masix2.m_i_frag
348#define i_fsize osd2.masix2.m_i_fsize
349#define i_reserved2 osd2.masix2.m_i_reserved2
350
351#endif /* defined(__KERNEL__) || defined(__linux__) */
352
353/*
354 * File system states
355 */
356#define EXT3_VALID_FS 0x0001 /* Unmounted cleanly */
357#define EXT3_ERROR_FS 0x0002 /* Errors detected */
358#define EXT3_ORPHAN_FS 0x0004 /* Orphans being recovered */
359
360/*
361 * Mount flags
362 */
363#define EXT3_MOUNT_CHECK 0x00001 /* Do mount-time checks */
364#define EXT3_MOUNT_OLDALLOC 0x00002 /* Don't use the new Orlov allocator */
365#define EXT3_MOUNT_GRPID 0x00004 /* Create files with directory's group */
366#define EXT3_MOUNT_DEBUG 0x00008 /* Some debugging messages */
367#define EXT3_MOUNT_ERRORS_CONT 0x00010 /* Continue on errors */
368#define EXT3_MOUNT_ERRORS_RO 0x00020 /* Remount fs ro on errors */
369#define EXT3_MOUNT_ERRORS_PANIC 0x00040 /* Panic on errors */
370#define EXT3_MOUNT_MINIX_DF 0x00080 /* Mimics the Minix statfs */
371#define EXT3_MOUNT_NOLOAD 0x00100 /* Don't use existing journal*/
372#define EXT3_MOUNT_ABORT 0x00200 /* Fatal error detected */
373#define EXT3_MOUNT_DATA_FLAGS 0x00C00 /* Mode for data writes: */
374#define EXT3_MOUNT_JOURNAL_DATA 0x00400 /* Write data to journal */
375#define EXT3_MOUNT_ORDERED_DATA 0x00800 /* Flush data before commit */
376#define EXT3_MOUNT_WRITEBACK_DATA 0x00C00 /* No data ordering */
377#define EXT3_MOUNT_UPDATE_JOURNAL 0x01000 /* Update the journal format */
378#define EXT3_MOUNT_NO_UID32 0x02000 /* Disable 32-bit UIDs */
379#define EXT3_MOUNT_XATTR_USER 0x04000 /* Extended user attributes */
380#define EXT3_MOUNT_POSIX_ACL 0x08000 /* POSIX Access Control Lists */
381#define EXT3_MOUNT_RESERVATION 0x10000 /* Preallocation */
382#define EXT3_MOUNT_BARRIER 0x20000 /* Use block barriers */
383#define EXT3_MOUNT_NOBH 0x40000 /* No bufferheads */
Jan Kara1f545872005-06-23 22:01:04 -0700384#define EXT3_MOUNT_QUOTA 0x80000 /* Some quota option set */
Mark Bellon8fc27512005-09-06 15:16:54 -0700385#define EXT3_MOUNT_USRQUOTA 0x100000 /* "old" user quota */
386#define EXT3_MOUNT_GRPQUOTA 0x200000 /* "old" group quota */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387
388/* Compatibility, for having both ext2_fs.h and ext3_fs.h included at once */
389#ifndef _LINUX_EXT2_FS_H
390#define clear_opt(o, opt) o &= ~EXT3_MOUNT_##opt
391#define set_opt(o, opt) o |= EXT3_MOUNT_##opt
392#define test_opt(sb, opt) (EXT3_SB(sb)->s_mount_opt & \
393 EXT3_MOUNT_##opt)
394#else
395#define EXT2_MOUNT_NOLOAD EXT3_MOUNT_NOLOAD
396#define EXT2_MOUNT_ABORT EXT3_MOUNT_ABORT
397#define EXT2_MOUNT_DATA_FLAGS EXT3_MOUNT_DATA_FLAGS
398#endif
399
400#define ext3_set_bit ext2_set_bit
401#define ext3_set_bit_atomic ext2_set_bit_atomic
402#define ext3_clear_bit ext2_clear_bit
403#define ext3_clear_bit_atomic ext2_clear_bit_atomic
404#define ext3_test_bit ext2_test_bit
405#define ext3_find_first_zero_bit ext2_find_first_zero_bit
406#define ext3_find_next_zero_bit ext2_find_next_zero_bit
407
408/*
409 * Maximal mount counts between two filesystem checks
410 */
411#define EXT3_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
412#define EXT3_DFL_CHECKINTERVAL 0 /* Don't use interval check */
413
414/*
415 * Behaviour when detecting errors
416 */
417#define EXT3_ERRORS_CONTINUE 1 /* Continue execution */
418#define EXT3_ERRORS_RO 2 /* Remount fs read-only */
419#define EXT3_ERRORS_PANIC 3 /* Panic */
420#define EXT3_ERRORS_DEFAULT EXT3_ERRORS_CONTINUE
421
422/*
423 * Structure of the super block
424 */
425struct ext3_super_block {
426/*00*/ __le32 s_inodes_count; /* Inodes count */
427 __le32 s_blocks_count; /* Blocks count */
428 __le32 s_r_blocks_count; /* Reserved blocks count */
429 __le32 s_free_blocks_count; /* Free blocks count */
430/*10*/ __le32 s_free_inodes_count; /* Free inodes count */
431 __le32 s_first_data_block; /* First Data Block */
432 __le32 s_log_block_size; /* Block size */
433 __le32 s_log_frag_size; /* Fragment size */
434/*20*/ __le32 s_blocks_per_group; /* # Blocks per group */
435 __le32 s_frags_per_group; /* # Fragments per group */
436 __le32 s_inodes_per_group; /* # Inodes per group */
437 __le32 s_mtime; /* Mount time */
438/*30*/ __le32 s_wtime; /* Write time */
439 __le16 s_mnt_count; /* Mount count */
440 __le16 s_max_mnt_count; /* Maximal mount count */
441 __le16 s_magic; /* Magic signature */
442 __le16 s_state; /* File system state */
443 __le16 s_errors; /* Behaviour when detecting errors */
444 __le16 s_minor_rev_level; /* minor revision level */
445/*40*/ __le32 s_lastcheck; /* time of last check */
446 __le32 s_checkinterval; /* max. time between checks */
447 __le32 s_creator_os; /* OS */
448 __le32 s_rev_level; /* Revision level */
449/*50*/ __le16 s_def_resuid; /* Default uid for reserved blocks */
450 __le16 s_def_resgid; /* Default gid for reserved blocks */
451 /*
452 * These fields are for EXT3_DYNAMIC_REV superblocks only.
453 *
454 * Note: the difference between the compatible feature set and
455 * the incompatible feature set is that if there is a bit set
456 * in the incompatible feature set that the kernel doesn't
457 * know about, it should refuse to mount the filesystem.
458 *
459 * e2fsck's requirements are more strict; if it doesn't know
460 * about a feature in either the compatible or incompatible
461 * feature set, it must abort and not try to meddle with
462 * things it doesn't understand...
463 */
464 __le32 s_first_ino; /* First non-reserved inode */
465 __le16 s_inode_size; /* size of inode structure */
466 __le16 s_block_group_nr; /* block group # of this superblock */
467 __le32 s_feature_compat; /* compatible feature set */
468/*60*/ __le32 s_feature_incompat; /* incompatible feature set */
469 __le32 s_feature_ro_compat; /* readonly-compatible feature set */
470/*68*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
471/*78*/ char s_volume_name[16]; /* volume name */
472/*88*/ char s_last_mounted[64]; /* directory where last mounted */
473/*C8*/ __le32 s_algorithm_usage_bitmap; /* For compression */
474 /*
475 * Performance hints. Directory preallocation should only
476 * happen if the EXT3_FEATURE_COMPAT_DIR_PREALLOC flag is on.
477 */
478 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
479 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
Dave Kleikampa4e4de32006-09-27 01:49:36 -0700480 __le16 s_reserved_gdt_blocks; /* Per group desc for online growth */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 /*
482 * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
483 */
484/*D0*/ __u8 s_journal_uuid[16]; /* uuid of journal superblock */
485/*E0*/ __le32 s_journal_inum; /* inode number of journal file */
486 __le32 s_journal_dev; /* device number of journal file */
487 __le32 s_last_orphan; /* start of list of inodes to delete */
488 __le32 s_hash_seed[4]; /* HTREE hash seed */
489 __u8 s_def_hash_version; /* Default hash version to use */
490 __u8 s_reserved_char_pad;
491 __u16 s_reserved_word_pad;
492 __le32 s_default_mount_opts;
Dave Kleikampe9ad5622006-09-27 01:49:35 -0700493 __le32 s_first_meta_bg; /* First metablock block group */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 __u32 s_reserved[190]; /* Padding to the end of the block */
495};
496
497#ifdef __KERNEL__
David Woodhoused85004e2006-04-25 15:18:46 +0100498#include <linux/ext3_fs_i.h>
499#include <linux/ext3_fs_sb.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500static inline struct ext3_sb_info * EXT3_SB(struct super_block *sb)
501{
502 return sb->s_fs_info;
503}
504static inline struct ext3_inode_info *EXT3_I(struct inode *inode)
505{
506 return container_of(inode, struct ext3_inode_info, vfs_inode);
507}
Neil Brown2ccb48e2006-07-30 03:03:01 -0700508
509static inline int ext3_valid_inum(struct super_block *sb, unsigned long ino)
510{
511 return ino == EXT3_ROOT_INO ||
512 ino == EXT3_JOURNAL_INO ||
513 ino == EXT3_RESIZE_INO ||
514 (ino >= EXT3_FIRST_INO(sb) &&
515 ino <= le32_to_cpu(EXT3_SB(sb)->s_es->s_inodes_count));
516}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517#else
518/* Assume that user mode programs are passing in an ext3fs superblock, not
519 * a kernel struct super_block. This will allow us to call the feature-test
520 * macros from user land. */
521#define EXT3_SB(sb) (sb)
522#endif
523
524#define NEXT_ORPHAN(inode) EXT3_I(inode)->i_dtime
525
526/*
527 * Codes for operating systems
528 */
529#define EXT3_OS_LINUX 0
530#define EXT3_OS_HURD 1
531#define EXT3_OS_MASIX 2
532#define EXT3_OS_FREEBSD 3
533#define EXT3_OS_LITES 4
534
535/*
536 * Revision levels
537 */
538#define EXT3_GOOD_OLD_REV 0 /* The good old (original) format */
539#define EXT3_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
540
541#define EXT3_CURRENT_REV EXT3_GOOD_OLD_REV
542#define EXT3_MAX_SUPP_REV EXT3_DYNAMIC_REV
543
544#define EXT3_GOOD_OLD_INODE_SIZE 128
545
546/*
547 * Feature set definitions
548 */
549
550#define EXT3_HAS_COMPAT_FEATURE(sb,mask) \
551 ( EXT3_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
552#define EXT3_HAS_RO_COMPAT_FEATURE(sb,mask) \
553 ( EXT3_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
554#define EXT3_HAS_INCOMPAT_FEATURE(sb,mask) \
555 ( EXT3_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
556#define EXT3_SET_COMPAT_FEATURE(sb,mask) \
557 EXT3_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
558#define EXT3_SET_RO_COMPAT_FEATURE(sb,mask) \
559 EXT3_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
560#define EXT3_SET_INCOMPAT_FEATURE(sb,mask) \
561 EXT3_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
562#define EXT3_CLEAR_COMPAT_FEATURE(sb,mask) \
563 EXT3_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
564#define EXT3_CLEAR_RO_COMPAT_FEATURE(sb,mask) \
565 EXT3_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
566#define EXT3_CLEAR_INCOMPAT_FEATURE(sb,mask) \
567 EXT3_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
568
569#define EXT3_FEATURE_COMPAT_DIR_PREALLOC 0x0001
570#define EXT3_FEATURE_COMPAT_IMAGIC_INODES 0x0002
571#define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
572#define EXT3_FEATURE_COMPAT_EXT_ATTR 0x0008
573#define EXT3_FEATURE_COMPAT_RESIZE_INODE 0x0010
574#define EXT3_FEATURE_COMPAT_DIR_INDEX 0x0020
575
576#define EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
577#define EXT3_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
578#define EXT3_FEATURE_RO_COMPAT_BTREE_DIR 0x0004
579
580#define EXT3_FEATURE_INCOMPAT_COMPRESSION 0x0001
581#define EXT3_FEATURE_INCOMPAT_FILETYPE 0x0002
582#define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
583#define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
584#define EXT3_FEATURE_INCOMPAT_META_BG 0x0010
585
586#define EXT3_FEATURE_COMPAT_SUPP EXT2_FEATURE_COMPAT_EXT_ATTR
587#define EXT3_FEATURE_INCOMPAT_SUPP (EXT3_FEATURE_INCOMPAT_FILETYPE| \
588 EXT3_FEATURE_INCOMPAT_RECOVER| \
589 EXT3_FEATURE_INCOMPAT_META_BG)
590#define EXT3_FEATURE_RO_COMPAT_SUPP (EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER| \
591 EXT3_FEATURE_RO_COMPAT_LARGE_FILE| \
592 EXT3_FEATURE_RO_COMPAT_BTREE_DIR)
593
594/*
595 * Default values for user and/or group using reserved blocks
596 */
597#define EXT3_DEF_RESUID 0
598#define EXT3_DEF_RESGID 0
599
600/*
601 * Default mount options
602 */
603#define EXT3_DEFM_DEBUG 0x0001
604#define EXT3_DEFM_BSDGROUPS 0x0002
605#define EXT3_DEFM_XATTR_USER 0x0004
606#define EXT3_DEFM_ACL 0x0008
607#define EXT3_DEFM_UID16 0x0010
608#define EXT3_DEFM_JMODE 0x0060
609#define EXT3_DEFM_JMODE_DATA 0x0020
610#define EXT3_DEFM_JMODE_ORDERED 0x0040
611#define EXT3_DEFM_JMODE_WBACK 0x0060
612
613/*
614 * Structure of a directory entry
615 */
616#define EXT3_NAME_LEN 255
617
618struct ext3_dir_entry {
619 __le32 inode; /* Inode number */
620 __le16 rec_len; /* Directory entry length */
621 __le16 name_len; /* Name length */
622 char name[EXT3_NAME_LEN]; /* File name */
623};
624
625/*
626 * The new version of the directory entry. Since EXT3 structures are
627 * stored in intel byte order, and the name_len field could never be
628 * bigger than 255 chars, it's safe to reclaim the extra byte for the
629 * file_type field.
630 */
631struct ext3_dir_entry_2 {
632 __le32 inode; /* Inode number */
633 __le16 rec_len; /* Directory entry length */
634 __u8 name_len; /* Name length */
635 __u8 file_type;
636 char name[EXT3_NAME_LEN]; /* File name */
637};
638
639/*
640 * Ext3 directory file types. Only the low 3 bits are used. The
641 * other bits are reserved for now.
642 */
643#define EXT3_FT_UNKNOWN 0
644#define EXT3_FT_REG_FILE 1
645#define EXT3_FT_DIR 2
646#define EXT3_FT_CHRDEV 3
647#define EXT3_FT_BLKDEV 4
648#define EXT3_FT_FIFO 5
649#define EXT3_FT_SOCK 6
650#define EXT3_FT_SYMLINK 7
651
652#define EXT3_FT_MAX 8
653
654/*
655 * EXT3_DIR_PAD defines the directory entries boundaries
656 *
657 * NOTE: It must be a multiple of 4
658 */
659#define EXT3_DIR_PAD 4
660#define EXT3_DIR_ROUND (EXT3_DIR_PAD - 1)
661#define EXT3_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT3_DIR_ROUND) & \
662 ~EXT3_DIR_ROUND)
663/*
664 * Hash Tree Directory indexing
665 * (c) Daniel Phillips, 2001
666 */
667
668#ifdef CONFIG_EXT3_INDEX
669 #define is_dx(dir) (EXT3_HAS_COMPAT_FEATURE(dir->i_sb, \
670 EXT3_FEATURE_COMPAT_DIR_INDEX) && \
671 (EXT3_I(dir)->i_flags & EXT3_INDEX_FL))
672#define EXT3_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT3_LINK_MAX)
673#define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
674#else
675 #define is_dx(dir) 0
676#define EXT3_DIR_LINK_MAX(dir) ((dir)->i_nlink >= EXT3_LINK_MAX)
677#define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2)
678#endif
679
680/* Legal values for the dx_root hash_version field: */
681
682#define DX_HASH_LEGACY 0
683#define DX_HASH_HALF_MD4 1
684#define DX_HASH_TEA 2
685
David Woodhousede654c92006-05-04 17:28:26 +0100686#ifdef __KERNEL__
687
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688/* hash info structure used by the directory hash */
689struct dx_hash_info
690{
691 u32 hash;
692 u32 minor_hash;
693 int hash_version;
694 u32 *seed;
695};
696
697#define EXT3_HTREE_EOF 0x7fffffff
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699/*
700 * Control parameters used by ext3_htree_next_block
701 */
702#define HASH_NB_ALWAYS 1
703
704
705/*
706 * Describe an inode's exact location on disk and in memory
707 */
708struct ext3_iloc
709{
710 struct buffer_head *bh;
711 unsigned long offset;
712 unsigned long block_group;
713};
714
715static inline struct ext3_inode *ext3_raw_inode(struct ext3_iloc *iloc)
716{
717 return (struct ext3_inode *) (iloc->bh->b_data + iloc->offset);
718}
719
720/*
721 * This structure is stuffed into the struct file's private_data field
722 * for directories. It is where we put information so that we can do
723 * readdir operations in hash tree order.
724 */
725struct dir_private_info {
726 struct rb_root root;
727 struct rb_node *curr_node;
728 struct fname *extra_fname;
729 loff_t last_pos;
730 __u32 curr_hash;
731 __u32 curr_minor_hash;
732 __u32 next_hash;
733};
734
Mingming Cao43d23f92006-06-25 05:48:07 -0700735/* calculate the first block number of the group */
736static inline ext3_fsblk_t
737ext3_group_first_block_no(struct super_block *sb, unsigned long group_no)
738{
739 return group_no * (ext3_fsblk_t)EXT3_BLOCKS_PER_GROUP(sb) +
740 le32_to_cpu(EXT3_SB(sb)->s_es->s_first_data_block);
741}
742
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743/*
744 * Special error return code only used by dx_probe() and its callers.
745 */
746#define ERR_BAD_DX_DIR -75000
747
748/*
749 * Function prototypes
750 */
751
752/*
753 * Ok, these declarations are also in <linux/kernel.h> but none of the
754 * ext3 source programs needs to include it so they are duplicated here.
755 */
756# define NORET_TYPE /**/
757# define ATTRIB_NORET __attribute__((noreturn))
758# define NORET_AND noreturn,
759
760/* balloc.c */
761extern int ext3_bg_has_super(struct super_block *sb, int group);
762extern unsigned long ext3_bg_num_gdb(struct super_block *sb, int group);
Mingming Cao1c2bf372006-06-25 05:48:06 -0700763extern ext3_fsblk_t ext3_new_block (handle_t *handle, struct inode *inode,
764 ext3_fsblk_t goal, int *errp);
765extern ext3_fsblk_t ext3_new_blocks (handle_t *handle, struct inode *inode,
766 ext3_fsblk_t goal, unsigned long *count, int *errp);
767extern void ext3_free_blocks (handle_t *handle, struct inode *inode,
768 ext3_fsblk_t block, unsigned long count);
769extern void ext3_free_blocks_sb (handle_t *handle, struct super_block *sb,
770 ext3_fsblk_t block, unsigned long count,
771 unsigned long *pdquot_freed_blocks);
Mingming Cao43d23f92006-06-25 05:48:07 -0700772extern ext3_fsblk_t ext3_count_free_blocks (struct super_block *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773extern void ext3_check_blocks_bitmap (struct super_block *);
774extern struct ext3_group_desc * ext3_get_group_desc(struct super_block * sb,
775 unsigned int block_group,
776 struct buffer_head ** bh);
777extern int ext3_should_retry_alloc(struct super_block *sb, int *retries);
778extern void ext3_init_block_alloc_info(struct inode *);
779extern void ext3_rsv_window_add(struct super_block *sb, struct ext3_reserve_window_node *rsv);
780
781/* dir.c */
782extern int ext3_check_dir_entry(const char *, struct inode *,
783 struct ext3_dir_entry_2 *,
784 struct buffer_head *, unsigned long);
785extern int ext3_htree_store_dirent(struct file *dir_file, __u32 hash,
786 __u32 minor_hash,
787 struct ext3_dir_entry_2 *dirent);
788extern void ext3_htree_free_dir_info(struct dir_private_info *p);
789
790/* fsync.c */
791extern int ext3_sync_file (struct file *, struct dentry *, int);
792
793/* hash.c */
794extern int ext3fs_dirhash(const char *name, int len, struct
795 dx_hash_info *hinfo);
796
797/* ialloc.c */
798extern struct inode * ext3_new_inode (handle_t *, struct inode *, int);
799extern void ext3_free_inode (handle_t *, struct inode *);
800extern struct inode * ext3_orphan_get (struct super_block *, unsigned long);
801extern unsigned long ext3_count_free_inodes (struct super_block *);
802extern unsigned long ext3_count_dirs (struct super_block *);
803extern void ext3_check_inodes_bitmap (struct super_block *);
804extern unsigned long ext3_count_free (struct buffer_head *, unsigned);
805
806
807/* inode.c */
Mingming Cao1c2bf372006-06-25 05:48:06 -0700808int ext3_forget(handle_t *handle, int is_metadata, struct inode *inode,
809 struct buffer_head *bh, ext3_fsblk_t blocknr);
Andrew Mortond8733c22006-03-23 03:00:11 -0800810struct buffer_head * ext3_getblk (handle_t *, struct inode *, long, int, int *);
811struct buffer_head * ext3_bread (handle_t *, struct inode *, int, int, int *);
Mingming Cao89747d32006-03-26 01:37:55 -0800812int ext3_get_blocks_handle(handle_t *handle, struct inode *inode,
813 sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
814 int create, int extend_disksize);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
816extern void ext3_read_inode (struct inode *);
817extern int ext3_write_inode (struct inode *, int);
818extern int ext3_setattr (struct dentry *, struct iattr *);
819extern void ext3_delete_inode (struct inode *);
820extern int ext3_sync_inode (handle_t *, struct inode *);
821extern void ext3_discard_reservation (struct inode *);
822extern void ext3_dirty_inode(struct inode *);
823extern int ext3_change_inode_journal_flag(struct inode *, int);
824extern int ext3_get_inode_loc(struct inode *, struct ext3_iloc *);
825extern void ext3_truncate (struct inode *);
826extern void ext3_set_inode_flags(struct inode *);
Jan Kara28be5ab2007-05-08 00:30:33 -0700827extern void ext3_get_inode_flags(struct ext3_inode_info *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828extern void ext3_set_aops(struct inode *inode);
829
830/* ioctl.c */
831extern int ext3_ioctl (struct inode *, struct file *, unsigned int,
832 unsigned long);
David Howells52a700c2006-08-29 19:06:23 +0100833extern long ext3_compat_ioctl (struct file *, unsigned int, unsigned long);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834
835/* namei.c */
836extern int ext3_orphan_add(handle_t *, struct inode *);
837extern int ext3_orphan_del(handle_t *, struct inode *);
838extern int ext3_htree_fill_tree(struct file *dir_file, __u32 start_hash,
839 __u32 start_minor_hash, __u32 *next_hash);
840
841/* resize.c */
842extern int ext3_group_add(struct super_block *sb,
843 struct ext3_new_group_data *input);
844extern int ext3_group_extend(struct super_block *sb,
845 struct ext3_super_block *es,
Mingming Cao43d23f92006-06-25 05:48:07 -0700846 ext3_fsblk_t n_blocks_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
848/* super.c */
849extern void ext3_error (struct super_block *, const char *, const char *, ...)
850 __attribute__ ((format (printf, 3, 4)));
851extern void __ext3_std_error (struct super_block *, const char *, int);
852extern void ext3_abort (struct super_block *, const char *, const char *, ...)
853 __attribute__ ((format (printf, 3, 4)));
854extern void ext3_warning (struct super_block *, const char *, const char *, ...)
855 __attribute__ ((format (printf, 3, 4)));
856extern void ext3_update_dynamic_rev (struct super_block *sb);
857
858#define ext3_std_error(sb, errno) \
859do { \
860 if ((errno)) \
861 __ext3_std_error((sb), __FUNCTION__, (errno)); \
862} while (0)
863
864/*
865 * Inodes and files operations
866 */
867
868/* dir.c */
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800869extern const struct file_operations ext3_dir_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
871/* file.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800872extern const struct inode_operations ext3_file_inode_operations;
Arjan van de Ven4b6f5d22006-03-28 01:56:42 -0800873extern const struct file_operations ext3_file_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
875/* namei.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800876extern const struct inode_operations ext3_dir_inode_operations;
877extern const struct inode_operations ext3_special_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
879/* symlink.c */
Arjan van de Venc5ef1c42007-02-12 00:55:40 -0800880extern const struct inode_operations ext3_symlink_inode_operations;
881extern const struct inode_operations ext3_fast_symlink_inode_operations;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882
883
884#endif /* __KERNEL__ */
885
886#endif /* _LINUX_EXT3_FS_H */