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