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