[PATCH] BLOCK: Move common FS-specific ioctls to linux/fs.h [try #6]
[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/magic.h>
21
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
35 /*max window size: 1024(direct blocks) + 3([t,d]indirect blocks) */
36 #define EXT3_MAX_RESERVE_BLOCKS         1027
37 #define EXT3_RESERVE_WINDOW_NOT_ALLOCATED 0
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 /*
71  * 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  */
122 struct 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 */
193 struct 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 */
204 struct 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  */
219 #define EXT3_IOC_GETFLAGS               FS_IOC_GETFLAGS
220 #define EXT3_IOC_SETFLAGS               FS_IOC_SETFLAGS
221 #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)
225 #define EXT3_IOC_GETVERSION_OLD         FS_IOC_GETVERSION
226 #define EXT3_IOC_SETVERSION_OLD         FS_IOC_SETVERSION
227 #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 /*
234  * ioctl commands in 32 bit emulation
235  */
236 #define EXT3_IOC32_GETVERSION           _IOR('f', 3, int)
237 #define EXT3_IOC32_SETVERSION           _IOW('f', 4, int)
238 #define EXT3_IOC32_GETRSVSZ             _IOR('f', 5, int)
239 #define EXT3_IOC32_SETRSVSZ             _IOW('f', 6, int)
240 #define EXT3_IOC32_GROUP_EXTEND         _IOW('f', 7, unsigned int)
241 #ifdef CONFIG_JBD_DEBUG
242 #define EXT3_IOC32_WAIT_FOR_READONLY    _IOR('f', 99, int)
243 #endif
244
245 /*
246  *  Mount options
247  */
248 struct ext3_mount_options {
249         unsigned long s_mount_opt;
250         uid_t s_resuid;
251         gid_t s_resgid;
252         unsigned long s_commit_interval;
253 #ifdef CONFIG_QUOTA
254         int s_jquota_fmt;
255         char *s_qf_names[MAXQUOTAS];
256 #endif
257 };
258
259 /*
260  * Structure of an inode on the disk
261  */
262 struct ext3_inode {
263         __le16  i_mode;         /* File mode */
264         __le16  i_uid;          /* Low 16 bits of Owner Uid */
265         __le32  i_size;         /* Size in bytes */
266         __le32  i_atime;        /* Access time */
267         __le32  i_ctime;        /* Creation time */
268         __le32  i_mtime;        /* Modification time */
269         __le32  i_dtime;        /* Deletion Time */
270         __le16  i_gid;          /* Low 16 bits of Group Id */
271         __le16  i_links_count;  /* Links count */
272         __le32  i_blocks;       /* Blocks count */
273         __le32  i_flags;        /* File flags */
274         union {
275                 struct {
276                         __u32  l_i_reserved1;
277                 } linux1;
278                 struct {
279                         __u32  h_i_translator;
280                 } hurd1;
281                 struct {
282                         __u32  m_i_reserved1;
283                 } masix1;
284         } osd1;                         /* OS dependent 1 */
285         __le32  i_block[EXT3_N_BLOCKS];/* Pointers to blocks */
286         __le32  i_generation;   /* File version (for NFS) */
287         __le32  i_file_acl;     /* File ACL */
288         __le32  i_dir_acl;      /* Directory ACL */
289         __le32  i_faddr;        /* Fragment address */
290         union {
291                 struct {
292                         __u8    l_i_frag;       /* Fragment number */
293                         __u8    l_i_fsize;      /* Fragment size */
294                         __u16   i_pad1;
295                         __le16  l_i_uid_high;   /* these 2 fields    */
296                         __le16  l_i_gid_high;   /* were reserved2[0] */
297                         __u32   l_i_reserved2;
298                 } linux2;
299                 struct {
300                         __u8    h_i_frag;       /* Fragment number */
301                         __u8    h_i_fsize;      /* Fragment size */
302                         __u16   h_i_mode_high;
303                         __u16   h_i_uid_high;
304                         __u16   h_i_gid_high;
305                         __u32   h_i_author;
306                 } hurd2;
307                 struct {
308                         __u8    m_i_frag;       /* Fragment number */
309                         __u8    m_i_fsize;      /* Fragment size */
310                         __u16   m_pad1;
311                         __u32   m_i_reserved2[2];
312                 } masix2;
313         } osd2;                         /* OS dependent 2 */
314         __le16  i_extra_isize;
315         __le16  i_pad1;
316 };
317
318 #define i_size_high     i_dir_acl
319
320 #if defined(__KERNEL__) || defined(__linux__)
321 #define i_reserved1     osd1.linux1.l_i_reserved1
322 #define i_frag          osd2.linux2.l_i_frag
323 #define i_fsize         osd2.linux2.l_i_fsize
324 #define i_uid_low       i_uid
325 #define i_gid_low       i_gid
326 #define i_uid_high      osd2.linux2.l_i_uid_high
327 #define i_gid_high      osd2.linux2.l_i_gid_high
328 #define i_reserved2     osd2.linux2.l_i_reserved2
329
330 #elif defined(__GNU__)
331
332 #define i_translator    osd1.hurd1.h_i_translator
333 #define i_frag          osd2.hurd2.h_i_frag;
334 #define i_fsize         osd2.hurd2.h_i_fsize;
335 #define i_uid_high      osd2.hurd2.h_i_uid_high
336 #define i_gid_high      osd2.hurd2.h_i_gid_high
337 #define i_author        osd2.hurd2.h_i_author
338
339 #elif defined(__masix__)
340
341 #define i_reserved1     osd1.masix1.m_i_reserved1
342 #define i_frag          osd2.masix2.m_i_frag
343 #define i_fsize         osd2.masix2.m_i_fsize
344 #define i_reserved2     osd2.masix2.m_i_reserved2
345
346 #endif /* defined(__KERNEL__) || defined(__linux__) */
347
348 /*
349  * File system states
350  */
351 #define EXT3_VALID_FS                   0x0001  /* Unmounted cleanly */
352 #define EXT3_ERROR_FS                   0x0002  /* Errors detected */
353 #define EXT3_ORPHAN_FS                  0x0004  /* Orphans being recovered */
354
355 /*
356  * Mount flags
357  */
358 #define EXT3_MOUNT_CHECK                0x00001 /* Do mount-time checks */
359 #define EXT3_MOUNT_OLDALLOC             0x00002  /* Don't use the new Orlov allocator */
360 #define EXT3_MOUNT_GRPID                0x00004 /* Create files with directory's group */
361 #define EXT3_MOUNT_DEBUG                0x00008 /* Some debugging messages */
362 #define EXT3_MOUNT_ERRORS_CONT          0x00010 /* Continue on errors */
363 #define EXT3_MOUNT_ERRORS_RO            0x00020 /* Remount fs ro on errors */
364 #define EXT3_MOUNT_ERRORS_PANIC         0x00040 /* Panic on errors */
365 #define EXT3_MOUNT_MINIX_DF             0x00080 /* Mimics the Minix statfs */
366 #define EXT3_MOUNT_NOLOAD               0x00100 /* Don't use existing journal*/
367 #define EXT3_MOUNT_ABORT                0x00200 /* Fatal error detected */
368 #define EXT3_MOUNT_DATA_FLAGS           0x00C00 /* Mode for data writes: */
369 #define EXT3_MOUNT_JOURNAL_DATA         0x00400 /* Write data to journal */
370 #define EXT3_MOUNT_ORDERED_DATA         0x00800 /* Flush data before commit */
371 #define EXT3_MOUNT_WRITEBACK_DATA       0x00C00 /* No data ordering */
372 #define EXT3_MOUNT_UPDATE_JOURNAL       0x01000 /* Update the journal format */
373 #define EXT3_MOUNT_NO_UID32             0x02000  /* Disable 32-bit UIDs */
374 #define EXT3_MOUNT_XATTR_USER           0x04000 /* Extended user attributes */
375 #define EXT3_MOUNT_POSIX_ACL            0x08000 /* POSIX Access Control Lists */
376 #define EXT3_MOUNT_RESERVATION          0x10000 /* Preallocation */
377 #define EXT3_MOUNT_BARRIER              0x20000 /* Use block barriers */
378 #define EXT3_MOUNT_NOBH                 0x40000 /* No bufferheads */
379 #define EXT3_MOUNT_QUOTA                0x80000 /* Some quota option set */
380 #define EXT3_MOUNT_USRQUOTA             0x100000 /* "old" user quota */
381 #define EXT3_MOUNT_GRPQUOTA             0x200000 /* "old" group quota */
382
383 /* Compatibility, for having both ext2_fs.h and ext3_fs.h included at once */
384 #ifndef _LINUX_EXT2_FS_H
385 #define clear_opt(o, opt)               o &= ~EXT3_MOUNT_##opt
386 #define set_opt(o, opt)                 o |= EXT3_MOUNT_##opt
387 #define test_opt(sb, opt)               (EXT3_SB(sb)->s_mount_opt & \
388                                          EXT3_MOUNT_##opt)
389 #else
390 #define EXT2_MOUNT_NOLOAD               EXT3_MOUNT_NOLOAD
391 #define EXT2_MOUNT_ABORT                EXT3_MOUNT_ABORT
392 #define EXT2_MOUNT_DATA_FLAGS           EXT3_MOUNT_DATA_FLAGS
393 #endif
394
395 #define ext3_set_bit                    ext2_set_bit
396 #define ext3_set_bit_atomic             ext2_set_bit_atomic
397 #define ext3_clear_bit                  ext2_clear_bit
398 #define ext3_clear_bit_atomic           ext2_clear_bit_atomic
399 #define ext3_test_bit                   ext2_test_bit
400 #define ext3_find_first_zero_bit        ext2_find_first_zero_bit
401 #define ext3_find_next_zero_bit         ext2_find_next_zero_bit
402
403 /*
404  * Maximal mount counts between two filesystem checks
405  */
406 #define EXT3_DFL_MAX_MNT_COUNT          20      /* Allow 20 mounts */
407 #define EXT3_DFL_CHECKINTERVAL          0       /* Don't use interval check */
408
409 /*
410  * Behaviour when detecting errors
411  */
412 #define EXT3_ERRORS_CONTINUE            1       /* Continue execution */
413 #define EXT3_ERRORS_RO                  2       /* Remount fs read-only */
414 #define EXT3_ERRORS_PANIC               3       /* Panic */
415 #define EXT3_ERRORS_DEFAULT             EXT3_ERRORS_CONTINUE
416
417 /*
418  * Structure of the super block
419  */
420 struct ext3_super_block {
421 /*00*/  __le32  s_inodes_count;         /* Inodes count */
422         __le32  s_blocks_count;         /* Blocks count */
423         __le32  s_r_blocks_count;       /* Reserved blocks count */
424         __le32  s_free_blocks_count;    /* Free blocks count */
425 /*10*/  __le32  s_free_inodes_count;    /* Free inodes count */
426         __le32  s_first_data_block;     /* First Data Block */
427         __le32  s_log_block_size;       /* Block size */
428         __le32  s_log_frag_size;        /* Fragment size */
429 /*20*/  __le32  s_blocks_per_group;     /* # Blocks per group */
430         __le32  s_frags_per_group;      /* # Fragments per group */
431         __le32  s_inodes_per_group;     /* # Inodes per group */
432         __le32  s_mtime;                /* Mount time */
433 /*30*/  __le32  s_wtime;                /* Write time */
434         __le16  s_mnt_count;            /* Mount count */
435         __le16  s_max_mnt_count;        /* Maximal mount count */
436         __le16  s_magic;                /* Magic signature */
437         __le16  s_state;                /* File system state */
438         __le16  s_errors;               /* Behaviour when detecting errors */
439         __le16  s_minor_rev_level;      /* minor revision level */
440 /*40*/  __le32  s_lastcheck;            /* time of last check */
441         __le32  s_checkinterval;        /* max. time between checks */
442         __le32  s_creator_os;           /* OS */
443         __le32  s_rev_level;            /* Revision level */
444 /*50*/  __le16  s_def_resuid;           /* Default uid for reserved blocks */
445         __le16  s_def_resgid;           /* Default gid for reserved blocks */
446         /*
447          * These fields are for EXT3_DYNAMIC_REV superblocks only.
448          *
449          * Note: the difference between the compatible feature set and
450          * the incompatible feature set is that if there is a bit set
451          * in the incompatible feature set that the kernel doesn't
452          * know about, it should refuse to mount the filesystem.
453          *
454          * e2fsck's requirements are more strict; if it doesn't know
455          * about a feature in either the compatible or incompatible
456          * feature set, it must abort and not try to meddle with
457          * things it doesn't understand...
458          */
459         __le32  s_first_ino;            /* First non-reserved inode */
460         __le16   s_inode_size;          /* size of inode structure */
461         __le16  s_block_group_nr;       /* block group # of this superblock */
462         __le32  s_feature_compat;       /* compatible feature set */
463 /*60*/  __le32  s_feature_incompat;     /* incompatible feature set */
464         __le32  s_feature_ro_compat;    /* readonly-compatible feature set */
465 /*68*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
466 /*78*/  char    s_volume_name[16];      /* volume name */
467 /*88*/  char    s_last_mounted[64];     /* directory where last mounted */
468 /*C8*/  __le32  s_algorithm_usage_bitmap; /* For compression */
469         /*
470          * Performance hints.  Directory preallocation should only
471          * happen if the EXT3_FEATURE_COMPAT_DIR_PREALLOC flag is on.
472          */
473         __u8    s_prealloc_blocks;      /* Nr of blocks to try to preallocate*/
474         __u8    s_prealloc_dir_blocks;  /* Nr to preallocate for dirs */
475         __le16  s_reserved_gdt_blocks;  /* Per group desc for online growth */
476         /*
477          * Journaling support valid if EXT3_FEATURE_COMPAT_HAS_JOURNAL set.
478          */
479 /*D0*/  __u8    s_journal_uuid[16];     /* uuid of journal superblock */
480 /*E0*/  __le32  s_journal_inum;         /* inode number of journal file */
481         __le32  s_journal_dev;          /* device number of journal file */
482         __le32  s_last_orphan;          /* start of list of inodes to delete */
483         __le32  s_hash_seed[4];         /* HTREE hash seed */
484         __u8    s_def_hash_version;     /* Default hash version to use */
485         __u8    s_reserved_char_pad;
486         __u16   s_reserved_word_pad;
487         __le32  s_default_mount_opts;
488         __le32  s_first_meta_bg;        /* First metablock block group */
489         __u32   s_reserved[190];        /* Padding to the end of the block */
490 };
491
492 #ifdef __KERNEL__
493 #include <linux/ext3_fs_i.h>
494 #include <linux/ext3_fs_sb.h>
495 static inline struct ext3_sb_info * EXT3_SB(struct super_block *sb)
496 {
497         return sb->s_fs_info;
498 }
499 static inline struct ext3_inode_info *EXT3_I(struct inode *inode)
500 {
501         return container_of(inode, struct ext3_inode_info, vfs_inode);
502 }
503
504 static inline int ext3_valid_inum(struct super_block *sb, unsigned long ino)
505 {
506         return ino == EXT3_ROOT_INO ||
507                 ino == EXT3_JOURNAL_INO ||
508                 ino == EXT3_RESIZE_INO ||
509                 (ino >= EXT3_FIRST_INO(sb) &&
510                  ino <= le32_to_cpu(EXT3_SB(sb)->s_es->s_inodes_count));
511 }
512 #else
513 /* Assume that user mode programs are passing in an ext3fs superblock, not
514  * a kernel struct super_block.  This will allow us to call the feature-test
515  * macros from user land. */
516 #define EXT3_SB(sb)     (sb)
517 #endif
518
519 #define NEXT_ORPHAN(inode) EXT3_I(inode)->i_dtime
520
521 /*
522  * Codes for operating systems
523  */
524 #define EXT3_OS_LINUX           0
525 #define EXT3_OS_HURD            1
526 #define EXT3_OS_MASIX           2
527 #define EXT3_OS_FREEBSD         3
528 #define EXT3_OS_LITES           4
529
530 /*
531  * Revision levels
532  */
533 #define EXT3_GOOD_OLD_REV       0       /* The good old (original) format */
534 #define EXT3_DYNAMIC_REV        1       /* V2 format w/ dynamic inode sizes */
535
536 #define EXT3_CURRENT_REV        EXT3_GOOD_OLD_REV
537 #define EXT3_MAX_SUPP_REV       EXT3_DYNAMIC_REV
538
539 #define EXT3_GOOD_OLD_INODE_SIZE 128
540
541 /*
542  * Feature set definitions
543  */
544
545 #define EXT3_HAS_COMPAT_FEATURE(sb,mask)                        \
546         ( EXT3_SB(sb)->s_es->s_feature_compat & cpu_to_le32(mask) )
547 #define EXT3_HAS_RO_COMPAT_FEATURE(sb,mask)                     \
548         ( EXT3_SB(sb)->s_es->s_feature_ro_compat & cpu_to_le32(mask) )
549 #define EXT3_HAS_INCOMPAT_FEATURE(sb,mask)                      \
550         ( EXT3_SB(sb)->s_es->s_feature_incompat & cpu_to_le32(mask) )
551 #define EXT3_SET_COMPAT_FEATURE(sb,mask)                        \
552         EXT3_SB(sb)->s_es->s_feature_compat |= cpu_to_le32(mask)
553 #define EXT3_SET_RO_COMPAT_FEATURE(sb,mask)                     \
554         EXT3_SB(sb)->s_es->s_feature_ro_compat |= cpu_to_le32(mask)
555 #define EXT3_SET_INCOMPAT_FEATURE(sb,mask)                      \
556         EXT3_SB(sb)->s_es->s_feature_incompat |= cpu_to_le32(mask)
557 #define EXT3_CLEAR_COMPAT_FEATURE(sb,mask)                      \
558         EXT3_SB(sb)->s_es->s_feature_compat &= ~cpu_to_le32(mask)
559 #define EXT3_CLEAR_RO_COMPAT_FEATURE(sb,mask)                   \
560         EXT3_SB(sb)->s_es->s_feature_ro_compat &= ~cpu_to_le32(mask)
561 #define EXT3_CLEAR_INCOMPAT_FEATURE(sb,mask)                    \
562         EXT3_SB(sb)->s_es->s_feature_incompat &= ~cpu_to_le32(mask)
563
564 #define EXT3_FEATURE_COMPAT_DIR_PREALLOC        0x0001
565 #define EXT3_FEATURE_COMPAT_IMAGIC_INODES       0x0002
566 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL         0x0004
567 #define EXT3_FEATURE_COMPAT_EXT_ATTR            0x0008
568 #define EXT3_FEATURE_COMPAT_RESIZE_INODE        0x0010
569 #define EXT3_FEATURE_COMPAT_DIR_INDEX           0x0020
570
571 #define EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER     0x0001
572 #define EXT3_FEATURE_RO_COMPAT_LARGE_FILE       0x0002
573 #define EXT3_FEATURE_RO_COMPAT_BTREE_DIR        0x0004
574
575 #define EXT3_FEATURE_INCOMPAT_COMPRESSION       0x0001
576 #define EXT3_FEATURE_INCOMPAT_FILETYPE          0x0002
577 #define EXT3_FEATURE_INCOMPAT_RECOVER           0x0004 /* Needs recovery */
578 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV       0x0008 /* Journal device */
579 #define EXT3_FEATURE_INCOMPAT_META_BG           0x0010
580
581 #define EXT3_FEATURE_COMPAT_SUPP        EXT2_FEATURE_COMPAT_EXT_ATTR
582 #define EXT3_FEATURE_INCOMPAT_SUPP      (EXT3_FEATURE_INCOMPAT_FILETYPE| \
583                                          EXT3_FEATURE_INCOMPAT_RECOVER| \
584                                          EXT3_FEATURE_INCOMPAT_META_BG)
585 #define EXT3_FEATURE_RO_COMPAT_SUPP     (EXT3_FEATURE_RO_COMPAT_SPARSE_SUPER| \
586                                          EXT3_FEATURE_RO_COMPAT_LARGE_FILE| \
587                                          EXT3_FEATURE_RO_COMPAT_BTREE_DIR)
588
589 /*
590  * Default values for user and/or group using reserved blocks
591  */
592 #define EXT3_DEF_RESUID         0
593 #define EXT3_DEF_RESGID         0
594
595 /*
596  * Default mount options
597  */
598 #define EXT3_DEFM_DEBUG         0x0001
599 #define EXT3_DEFM_BSDGROUPS     0x0002
600 #define EXT3_DEFM_XATTR_USER    0x0004
601 #define EXT3_DEFM_ACL           0x0008
602 #define EXT3_DEFM_UID16         0x0010
603 #define EXT3_DEFM_JMODE         0x0060
604 #define EXT3_DEFM_JMODE_DATA    0x0020
605 #define EXT3_DEFM_JMODE_ORDERED 0x0040
606 #define EXT3_DEFM_JMODE_WBACK   0x0060
607
608 /*
609  * Structure of a directory entry
610  */
611 #define EXT3_NAME_LEN 255
612
613 struct ext3_dir_entry {
614         __le32  inode;                  /* Inode number */
615         __le16  rec_len;                /* Directory entry length */
616         __le16  name_len;               /* Name length */
617         char    name[EXT3_NAME_LEN];    /* File name */
618 };
619
620 /*
621  * The new version of the directory entry.  Since EXT3 structures are
622  * stored in intel byte order, and the name_len field could never be
623  * bigger than 255 chars, it's safe to reclaim the extra byte for the
624  * file_type field.
625  */
626 struct ext3_dir_entry_2 {
627         __le32  inode;                  /* Inode number */
628         __le16  rec_len;                /* Directory entry length */
629         __u8    name_len;               /* Name length */
630         __u8    file_type;
631         char    name[EXT3_NAME_LEN];    /* File name */
632 };
633
634 /*
635  * Ext3 directory file types.  Only the low 3 bits are used.  The
636  * other bits are reserved for now.
637  */
638 #define EXT3_FT_UNKNOWN         0
639 #define EXT3_FT_REG_FILE        1
640 #define EXT3_FT_DIR             2
641 #define EXT3_FT_CHRDEV          3
642 #define EXT3_FT_BLKDEV          4
643 #define EXT3_FT_FIFO            5
644 #define EXT3_FT_SOCK            6
645 #define EXT3_FT_SYMLINK         7
646
647 #define EXT3_FT_MAX             8
648
649 /*
650  * EXT3_DIR_PAD defines the directory entries boundaries
651  *
652  * NOTE: It must be a multiple of 4
653  */
654 #define EXT3_DIR_PAD                    4
655 #define EXT3_DIR_ROUND                  (EXT3_DIR_PAD - 1)
656 #define EXT3_DIR_REC_LEN(name_len)      (((name_len) + 8 + EXT3_DIR_ROUND) & \
657                                          ~EXT3_DIR_ROUND)
658 /*
659  * Hash Tree Directory indexing
660  * (c) Daniel Phillips, 2001
661  */
662
663 #ifdef CONFIG_EXT3_INDEX
664   #define is_dx(dir) (EXT3_HAS_COMPAT_FEATURE(dir->i_sb, \
665                                               EXT3_FEATURE_COMPAT_DIR_INDEX) && \
666                       (EXT3_I(dir)->i_flags & EXT3_INDEX_FL))
667 #define EXT3_DIR_LINK_MAX(dir) (!is_dx(dir) && (dir)->i_nlink >= EXT3_LINK_MAX)
668 #define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2 || (dir)->i_nlink == 1)
669 #else
670   #define is_dx(dir) 0
671 #define EXT3_DIR_LINK_MAX(dir) ((dir)->i_nlink >= EXT3_LINK_MAX)
672 #define EXT3_DIR_LINK_EMPTY(dir) ((dir)->i_nlink == 2)
673 #endif
674
675 /* Legal values for the dx_root hash_version field: */
676
677 #define DX_HASH_LEGACY          0
678 #define DX_HASH_HALF_MD4        1
679 #define DX_HASH_TEA             2
680
681 #ifdef __KERNEL__
682
683 /* hash info structure used by the directory hash */
684 struct dx_hash_info
685 {
686         u32             hash;
687         u32             minor_hash;
688         int             hash_version;
689         u32             *seed;
690 };
691
692 #define EXT3_HTREE_EOF  0x7fffffff
693
694 /*
695  * Control parameters used by ext3_htree_next_block
696  */
697 #define HASH_NB_ALWAYS          1
698
699
700 /*
701  * Describe an inode's exact location on disk and in memory
702  */
703 struct ext3_iloc
704 {
705         struct buffer_head *bh;
706         unsigned long offset;
707         unsigned long block_group;
708 };
709
710 static inline struct ext3_inode *ext3_raw_inode(struct ext3_iloc *iloc)
711 {
712         return (struct ext3_inode *) (iloc->bh->b_data + iloc->offset);
713 }
714
715 /*
716  * This structure is stuffed into the struct file's private_data field
717  * for directories.  It is where we put information so that we can do
718  * readdir operations in hash tree order.
719  */
720 struct dir_private_info {
721         struct rb_root  root;
722         struct rb_node  *curr_node;
723         struct fname    *extra_fname;
724         loff_t          last_pos;
725         __u32           curr_hash;
726         __u32           curr_minor_hash;
727         __u32           next_hash;
728 };
729
730 /* calculate the first block number of the group */
731 static inline ext3_fsblk_t
732 ext3_group_first_block_no(struct super_block *sb, unsigned long group_no)
733 {
734         return group_no * (ext3_fsblk_t)EXT3_BLOCKS_PER_GROUP(sb) +
735                 le32_to_cpu(EXT3_SB(sb)->s_es->s_first_data_block);
736 }
737
738 /*
739  * Special error return code only used by dx_probe() and its callers.
740  */
741 #define ERR_BAD_DX_DIR  -75000
742
743 /*
744  * Function prototypes
745  */
746
747 /*
748  * Ok, these declarations are also in <linux/kernel.h> but none of the
749  * ext3 source programs needs to include it so they are duplicated here.
750  */
751 # define NORET_TYPE    /**/
752 # define ATTRIB_NORET  __attribute__((noreturn))
753 # define NORET_AND     noreturn,
754
755 /* balloc.c */
756 extern int ext3_bg_has_super(struct super_block *sb, int group);
757 extern unsigned long ext3_bg_num_gdb(struct super_block *sb, int group);
758 extern ext3_fsblk_t ext3_new_block (handle_t *handle, struct inode *inode,
759                         ext3_fsblk_t goal, int *errp);
760 extern ext3_fsblk_t ext3_new_blocks (handle_t *handle, struct inode *inode,
761                         ext3_fsblk_t goal, unsigned long *count, int *errp);
762 extern void ext3_free_blocks (handle_t *handle, struct inode *inode,
763                         ext3_fsblk_t block, unsigned long count);
764 extern void ext3_free_blocks_sb (handle_t *handle, struct super_block *sb,
765                                  ext3_fsblk_t block, unsigned long count,
766                                 unsigned long *pdquot_freed_blocks);
767 extern ext3_fsblk_t ext3_count_free_blocks (struct super_block *);
768 extern void ext3_check_blocks_bitmap (struct super_block *);
769 extern struct ext3_group_desc * ext3_get_group_desc(struct super_block * sb,
770                                                     unsigned int block_group,
771                                                     struct buffer_head ** bh);
772 extern int ext3_should_retry_alloc(struct super_block *sb, int *retries);
773 extern void ext3_init_block_alloc_info(struct inode *);
774 extern void ext3_rsv_window_add(struct super_block *sb, struct ext3_reserve_window_node *rsv);
775
776 /* dir.c */
777 extern int ext3_check_dir_entry(const char *, struct inode *,
778                                 struct ext3_dir_entry_2 *,
779                                 struct buffer_head *, unsigned long);
780 extern int ext3_htree_store_dirent(struct file *dir_file, __u32 hash,
781                                     __u32 minor_hash,
782                                     struct ext3_dir_entry_2 *dirent);
783 extern void ext3_htree_free_dir_info(struct dir_private_info *p);
784
785 /* fsync.c */
786 extern int ext3_sync_file (struct file *, struct dentry *, int);
787
788 /* hash.c */
789 extern int ext3fs_dirhash(const char *name, int len, struct
790                           dx_hash_info *hinfo);
791
792 /* ialloc.c */
793 extern struct inode * ext3_new_inode (handle_t *, struct inode *, int);
794 extern void ext3_free_inode (handle_t *, struct inode *);
795 extern struct inode * ext3_orphan_get (struct super_block *, unsigned long);
796 extern unsigned long ext3_count_free_inodes (struct super_block *);
797 extern unsigned long ext3_count_dirs (struct super_block *);
798 extern void ext3_check_inodes_bitmap (struct super_block *);
799 extern unsigned long ext3_count_free (struct buffer_head *, unsigned);
800
801
802 /* inode.c */
803 int ext3_forget(handle_t *handle, int is_metadata, struct inode *inode,
804                 struct buffer_head *bh, ext3_fsblk_t blocknr);
805 struct buffer_head * ext3_getblk (handle_t *, struct inode *, long, int, int *);
806 struct buffer_head * ext3_bread (handle_t *, struct inode *, int, int, int *);
807 int ext3_get_blocks_handle(handle_t *handle, struct inode *inode,
808         sector_t iblock, unsigned long maxblocks, struct buffer_head *bh_result,
809         int create, int extend_disksize);
810
811 extern void ext3_read_inode (struct inode *);
812 extern int  ext3_write_inode (struct inode *, int);
813 extern int  ext3_setattr (struct dentry *, struct iattr *);
814 extern void ext3_delete_inode (struct inode *);
815 extern int  ext3_sync_inode (handle_t *, struct inode *);
816 extern void ext3_discard_reservation (struct inode *);
817 extern void ext3_dirty_inode(struct inode *);
818 extern int ext3_change_inode_journal_flag(struct inode *, int);
819 extern int ext3_get_inode_loc(struct inode *, struct ext3_iloc *);
820 extern void ext3_truncate (struct inode *);
821 extern void ext3_set_inode_flags(struct inode *);
822 extern void ext3_set_aops(struct inode *inode);
823
824 /* ioctl.c */
825 extern int ext3_ioctl (struct inode *, struct file *, unsigned int,
826                        unsigned long);
827
828 /* namei.c */
829 extern int ext3_orphan_add(handle_t *, struct inode *);
830 extern int ext3_orphan_del(handle_t *, struct inode *);
831 extern int ext3_htree_fill_tree(struct file *dir_file, __u32 start_hash,
832                                 __u32 start_minor_hash, __u32 *next_hash);
833
834 /* resize.c */
835 extern int ext3_group_add(struct super_block *sb,
836                                 struct ext3_new_group_data *input);
837 extern int ext3_group_extend(struct super_block *sb,
838                                 struct ext3_super_block *es,
839                                 ext3_fsblk_t n_blocks_count);
840
841 /* super.c */
842 extern void ext3_error (struct super_block *, const char *, const char *, ...)
843         __attribute__ ((format (printf, 3, 4)));
844 extern void __ext3_std_error (struct super_block *, const char *, int);
845 extern void ext3_abort (struct super_block *, const char *, const char *, ...)
846         __attribute__ ((format (printf, 3, 4)));
847 extern void ext3_warning (struct super_block *, const char *, const char *, ...)
848         __attribute__ ((format (printf, 3, 4)));
849 extern void ext3_update_dynamic_rev (struct super_block *sb);
850
851 #define ext3_std_error(sb, errno)                               \
852 do {                                                            \
853         if ((errno))                                            \
854                 __ext3_std_error((sb), __FUNCTION__, (errno));  \
855 } while (0)
856
857 /*
858  * Inodes and files operations
859  */
860
861 /* dir.c */
862 extern const struct file_operations ext3_dir_operations;
863
864 /* file.c */
865 extern struct inode_operations ext3_file_inode_operations;
866 extern const struct file_operations ext3_file_operations;
867
868 /* namei.c */
869 extern struct inode_operations ext3_dir_inode_operations;
870 extern struct inode_operations ext3_special_inode_operations;
871
872 /* symlink.c */
873 extern struct inode_operations ext3_symlink_inode_operations;
874 extern struct inode_operations ext3_fast_symlink_inode_operations;
875
876
877 #endif  /* __KERNEL__ */
878
879 #endif  /* _LINUX_EXT3_FS_H */