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