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