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