blob: e427addf99c8477a45460c16af0093168764d08d [file] [log] [blame]
Theodore Ts'o9f8046f2001-05-14 11:35:52 +00001/*
2 * linux/include/linux/ext2_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_EXT2_FS_H
17#define _LINUX_EXT2_FS_H
18
Theodore Ts'o797f5ef2001-06-01 23:49:46 +000019#include <ext2fs/ext2_types.h> /* Changed from linux/types.h */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000020
21/*
22 * The second extended filesystem constants/structures
23 */
24
25/*
26 * Define EXT2FS_DEBUG to produce debug messages
27 */
28#undef EXT2FS_DEBUG
29
30/*
31 * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
32 */
33#define EXT2_PREALLOCATE
34#define EXT2_DEFAULT_PREALLOC_BLOCKS 8
35
36/*
37 * The second extended file system version
38 */
39#define EXT2FS_DATE "95/08/09"
40#define EXT2FS_VERSION "0.5b"
41
42/*
Andreas Dilger0fbd1a82002-05-23 00:32:34 -060043 * Special inode numbers
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000044 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -060045#define EXT2_BAD_INO 1 /* Bad blocks inode */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000046#define EXT2_ROOT_INO 2 /* Root inode */
47#define EXT2_ACL_IDX_INO 3 /* ACL inode */
48#define EXT2_ACL_DATA_INO 4 /* ACL inode */
49#define EXT2_BOOT_LOADER_INO 5 /* Boot loader inode */
50#define EXT2_UNDEL_DIR_INO 6 /* Undelete directory inode */
51#define EXT2_RESIZE_INO 7 /* Reserved group descriptors inode */
52#define EXT2_JOURNAL_INO 8 /* Journal inode */
53
54/* First non-reserved inode for old ext2 filesystems */
55#define EXT2_GOOD_OLD_FIRST_INO 11
56
57/*
58 * The second extended file system magic number
59 */
60#define EXT2_SUPER_MAGIC 0xEF53
61
Andreas Dilger0fbd1a82002-05-23 00:32:34 -060062#ifdef __KERNEL__
63#define EXT2_SB(sb) (&((sb)->u.ext2_sb))
64#else
65/* Assume that user mode programs are passing in an ext2fs superblock, not
66 * a kernel struct super_block. This will allow us to call the feature-test
67 * macros from user land. */
68#define EXT2_SB(sb) (sb)
69#endif
70
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000071/*
72 * Maximal count of links to a file
73 */
74#define EXT2_LINK_MAX 32000
75
76/*
77 * Macro-instructions used to manage several block sizes
78 */
Andreas Dilger932a4892002-05-16 03:20:07 -060079#define EXT2_MIN_BLOCK_LOG_SIZE 10 /* 1024 */
Theodore Ts'o39dc1c42004-11-29 22:14:23 -050080#define EXT2_MAX_BLOCK_LOG_SIZE 16 /* 65536 */
Andreas Dilger7da78ff2002-06-09 17:38:50 -060081#define EXT2_MIN_BLOCK_SIZE (1 << EXT2_MIN_BLOCK_LOG_SIZE)
82#define EXT2_MAX_BLOCK_SIZE (1 << EXT2_MAX_BLOCK_LOG_SIZE)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000083#ifdef __KERNEL__
Andreas Dilger7da78ff2002-06-09 17:38:50 -060084#define EXT2_BLOCK_SIZE(s) ((s)->s_blocksize)
85#define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_blocksize_bits)
Andreas Dilger0fbd1a82002-05-23 00:32:34 -060086#define EXT2_ADDR_PER_BLOCK_BITS(s) (EXT2_SB(s)->addr_per_block_bits)
Andreas Dilger7da78ff2002-06-09 17:38:50 -060087#define EXT2_INODE_SIZE(s) (EXT2_SB(s)->s_inode_size)
88#define EXT2_FIRST_INO(s) (EXT2_SB(s)->s_first_ino)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000089#else
Andreas Dilger7da78ff2002-06-09 17:38:50 -060090#define EXT2_BLOCK_SIZE(s) (EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
91#define EXT2_BLOCK_SIZE_BITS(s) ((s)->s_log_block_size + 10)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000092#define EXT2_INODE_SIZE(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
Andreas Dilger7da78ff2002-06-09 17:38:50 -060093 EXT2_GOOD_OLD_INODE_SIZE : (s)->s_inode_size)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000094#define EXT2_FIRST_INO(s) (((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
Andreas Dilger7da78ff2002-06-09 17:38:50 -060095 EXT2_GOOD_OLD_FIRST_INO : (s)->s_first_ino)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000096#endif
Andreas Dilger7da78ff2002-06-09 17:38:50 -060097#define EXT2_ADDR_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof(__u32))
Theodore Ts'o9f8046f2001-05-14 11:35:52 +000098
99/*
100 * Macro-instructions used to manage fragments
101 */
Andreas Dilger932a4892002-05-16 03:20:07 -0600102#define EXT2_MIN_FRAG_SIZE EXT2_MIN_BLOCK_SIZE
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600103#define EXT2_MAX_FRAG_SIZE EXT2_MAX_BLOCK_SIZE
Andreas Dilger932a4892002-05-16 03:20:07 -0600104#define EXT2_MIN_FRAG_LOG_SIZE EXT2_MIN_BLOCK_LOG_SIZE
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000105#ifdef __KERNEL__
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600106# define EXT2_FRAG_SIZE(s) (EXT2_SB(s)->s_frag_size)
107# define EXT2_FRAGS_PER_BLOCK(s) (EXT2_SB(s)->s_frags_per_block)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000108#else
109# define EXT2_FRAG_SIZE(s) (EXT2_MIN_FRAG_SIZE << (s)->s_log_frag_size)
110# define EXT2_FRAGS_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / EXT2_FRAG_SIZE(s))
111#endif
112
113/*
114 * ACL structures
115 */
116struct ext2_acl_header /* Header of Access Control Lists */
117{
118 __u32 aclh_size;
119 __u32 aclh_file_count;
120 __u32 aclh_acle_count;
121 __u32 aclh_first_acle;
122};
123
124struct ext2_acl_entry /* Access Control List Entry */
125{
126 __u32 acle_size;
127 __u16 acle_perms; /* Access permissions */
128 __u16 acle_type; /* Type of entry */
129 __u16 acle_tag; /* User or group identity */
130 __u16 acle_pad1;
131 __u32 acle_next; /* Pointer on next entry for the */
132 /* same inode or on next free entry */
133};
134
135/*
136 * Structure of a blocks group descriptor
137 */
138struct ext2_group_desc
139{
140 __u32 bg_block_bitmap; /* Blocks bitmap block */
141 __u32 bg_inode_bitmap; /* Inodes bitmap block */
142 __u32 bg_inode_table; /* Inodes table block */
143 __u16 bg_free_blocks_count; /* Free blocks count */
144 __u16 bg_free_inodes_count; /* Free inodes count */
145 __u16 bg_used_dirs_count; /* Directories count */
146 __u16 bg_pad;
147 __u32 bg_reserved[3];
148};
149
150/*
Theodore Ts'odf614db2002-02-25 04:28:45 -0500151 * Data structures used by the directory indexing feature
152 *
153 * Note: all of the multibyte integer fields are little endian.
154 */
155
156/*
157 * Note: dx_root_info is laid out so that if it should somehow get
158 * overlaid by a dirent the two low bits of the hash version will be
159 * zero. Therefore, the hash version mod 4 should never be 0.
160 * Sincerely, the paranoia department.
161 */
162struct ext2_dx_root_info {
163 __u32 reserved_zero;
164 __u8 hash_version; /* 0 now, 1 at release */
165 __u8 info_length; /* 8 */
166 __u8 indirect_levels;
167 __u8 unused_flags;
168};
169
Theodore Ts'o503f9e72002-06-26 16:52:10 -0400170#define EXT2_HASH_LEGACY 0
171#define EXT2_HASH_HALF_MD4 1
Theodore Ts'ob33278c2002-08-17 10:52:51 -0400172#define EXT2_HASH_TEA 2
Theodore Ts'o503f9e72002-06-26 16:52:10 -0400173
174#define EXT2_HASH_FLAG_INCOMPAT 0x1
175
Theodore Ts'odf614db2002-02-25 04:28:45 -0500176struct ext2_dx_entry {
177 __u32 hash;
178 __u32 block;
179};
180
181struct ext2_dx_countlimit {
182 __u16 limit;
183 __u16 count;
184};
185
186
187/*
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000188 * Macro-instructions used to manage group descriptors
189 */
Andreas Dilgerb21bf262002-06-10 11:05:56 -0600190#define EXT2_BLOCKS_PER_GROUP(s) (EXT2_SB(s)->s_blocks_per_group)
191#define EXT2_INODES_PER_GROUP(s) (EXT2_SB(s)->s_inodes_per_group)
192#define EXT2_INODES_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s)/EXT2_INODE_SIZE(s))
193/* limits imposed by 16-bit value gd_free_{blocks,inode}_count */
194#define EXT2_MAX_BLOCKS_PER_GROUP(s) ((1 << 16) - 8)
195#define EXT2_MAX_INODES_PER_GROUP(s) ((1 << 16) - EXT2_INODES_PER_BLOCK(s))
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000196#ifdef __KERNEL__
Andreas Dilgerb21bf262002-06-10 11:05:56 -0600197#define EXT2_DESC_PER_BLOCK(s) (EXT2_SB(s)->s_desc_per_block)
198#define EXT2_DESC_PER_BLOCK_BITS(s) (EXT2_SB(s)->s_desc_per_block_bits)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000199#else
Andreas Dilgerb21bf262002-06-10 11:05:56 -0600200#define EXT2_DESC_PER_BLOCK(s) (EXT2_BLOCK_SIZE(s) / sizeof (struct ext2_group_desc))
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000201#endif
202
203/*
204 * Constants relative to the data blocks
205 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600206#define EXT2_NDIR_BLOCKS 12
207#define EXT2_IND_BLOCK EXT2_NDIR_BLOCKS
208#define EXT2_DIND_BLOCK (EXT2_IND_BLOCK + 1)
209#define EXT2_TIND_BLOCK (EXT2_DIND_BLOCK + 1)
210#define EXT2_N_BLOCKS (EXT2_TIND_BLOCK + 1)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000211
212/*
213 * Inode flags
214 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600215#define EXT2_SECRM_FL 0x00000001 /* Secure deletion */
216#define EXT2_UNRM_FL 0x00000002 /* Undelete */
217#define EXT2_COMPR_FL 0x00000004 /* Compress file */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000218#define EXT2_SYNC_FL 0x00000008 /* Synchronous updates */
219#define EXT2_IMMUTABLE_FL 0x00000010 /* Immutable file */
220#define EXT2_APPEND_FL 0x00000020 /* writes to file may only append */
221#define EXT2_NODUMP_FL 0x00000040 /* do not dump file */
222#define EXT2_NOATIME_FL 0x00000080 /* do not update atime */
223/* Reserved for compression usage... */
224#define EXT2_DIRTY_FL 0x00000100
225#define EXT2_COMPRBLK_FL 0x00000200 /* One or more compressed clusters */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600226#define EXT2_NOCOMPR_FL 0x00000400 /* Access raw compressed data */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000227#define EXT2_ECOMPR_FL 0x00000800 /* Compression error */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600228/* End compression flags --- maybe not all used */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000229#define EXT2_BTREE_FL 0x00001000 /* btree format dir */
Theodore Ts'ob10820c2001-05-21 05:23:31 +0000230#define EXT2_INDEX_FL 0x00001000 /* hash-indexed directory */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000231#define EXT2_IMAGIC_FL 0x00002000
232#define EXT3_JOURNAL_DATA_FL 0x00004000 /* file data should be journaled */
Theodore Ts'ob3f5b4c2001-11-05 19:22:02 -0500233#define EXT2_NOTAIL_FL 0x00008000 /* file tail should not be merged */
Theodore Ts'o88372d52002-06-15 18:58:39 -0400234#define EXT2_DIRSYNC_FL 0x00010000 /* Synchronous directory modifications */
Theodore Ts'o15f90112002-11-01 01:53:52 -0500235#define EXT2_TOPDIR_FL 0x00020000 /* Top of directory hierarchies*/
Theodore Ts'o39dc1c42004-11-29 22:14:23 -0500236#define EXT3_EXTENTS_FL 0x00080000 /* Inode uses extents */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000237#define EXT2_RESERVED_FL 0x80000000 /* reserved for ext2 lib */
238
Theodore Ts'o15f90112002-11-01 01:53:52 -0500239#define EXT2_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */
Theodore Ts'ob3f5b4c2001-11-05 19:22:02 -0500240#define EXT2_FL_USER_MODIFIABLE 0x000080FF /* User modifiable flags */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000241
242/*
243 * ioctl commands
244 */
Theodore Ts'obf692352006-03-17 19:45:45 -0500245
246/* Used for online resize */
247struct ext2_new_group_input {
248 __u32 group; /* Group number for this data */
249 __u32 block_bitmap; /* Absolute block number of block bitmap */
250 __u32 inode_bitmap; /* Absolute block number of inode bitmap */
251 __u32 inode_table; /* Absolute block number of inode table start */
252 __u32 blocks_count; /* Total number of blocks in this group */
253 __u16 reserved_blocks; /* Number of reserved blocks in this group */
254 __u16 unused; /* Number of reserved GDT blocks in group */
255};
256
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600257#define EXT2_IOC_GETFLAGS _IOR('f', 1, long)
258#define EXT2_IOC_SETFLAGS _IOW('f', 2, long)
259#define EXT2_IOC_GETVERSION _IOR('v', 1, long)
260#define EXT2_IOC_SETVERSION _IOW('v', 2, long)
Theodore Ts'obf692352006-03-17 19:45:45 -0500261#define EXT2_IOC_GETVERSION_NEW _IOR('f', 3, long)
262#define EXT2_IOC_SETVERSION_NEW _IOW('f', 4, long)
263#define EXT2_IOC_GROUP_EXTEND _IOW('f', 7, unsigned long)
264#define EXT2_IOC_GROUP_ADD _IOW('f', 8,struct ext2_new_group_input)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000265
266/*
267 * Structure of an inode on the disk
268 */
269struct ext2_inode {
270 __u16 i_mode; /* File mode */
271 __u16 i_uid; /* Low 16 bits of Owner Uid */
272 __u32 i_size; /* Size in bytes */
273 __u32 i_atime; /* Access time */
274 __u32 i_ctime; /* Creation time */
275 __u32 i_mtime; /* Modification time */
276 __u32 i_dtime; /* Deletion Time */
277 __u16 i_gid; /* Low 16 bits of Group Id */
278 __u16 i_links_count; /* Links count */
279 __u32 i_blocks; /* Blocks count */
280 __u32 i_flags; /* File flags */
281 union {
282 struct {
283 __u32 l_i_reserved1;
284 } linux1;
285 struct {
286 __u32 h_i_translator;
287 } hurd1;
288 struct {
289 __u32 m_i_reserved1;
290 } masix1;
291 } osd1; /* OS dependent 1 */
292 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
293 __u32 i_generation; /* File version (for NFS) */
294 __u32 i_file_acl; /* File ACL */
295 __u32 i_dir_acl; /* Directory ACL */
296 __u32 i_faddr; /* Fragment address */
297 union {
298 struct {
299 __u8 l_i_frag; /* Fragment number */
300 __u8 l_i_fsize; /* Fragment size */
301 __u16 i_pad1;
302 __u16 l_i_uid_high; /* these 2 fields */
303 __u16 l_i_gid_high; /* were reserved2[0] */
304 __u32 l_i_reserved2;
305 } linux2;
306 struct {
307 __u8 h_i_frag; /* Fragment number */
308 __u8 h_i_fsize; /* Fragment size */
309 __u16 h_i_mode_high;
310 __u16 h_i_uid_high;
311 __u16 h_i_gid_high;
312 __u32 h_i_author;
313 } hurd2;
314 struct {
315 __u8 m_i_frag; /* Fragment number */
316 __u8 m_i_fsize; /* Fragment size */
317 __u16 m_pad1;
318 __u32 m_i_reserved2[2];
319 } masix2;
320 } osd2; /* OS dependent 2 */
321};
322
Theodore Ts'o73311962005-01-25 23:42:56 -0500323/*
324 * Permanent part of an large inode on the disk
325 */
326struct ext2_inode_large {
327 __u16 i_mode; /* File mode */
328 __u16 i_uid; /* Low 16 bits of Owner Uid */
329 __u32 i_size; /* Size in bytes */
330 __u32 i_atime; /* Access time */
331 __u32 i_ctime; /* Creation time */
332 __u32 i_mtime; /* Modification time */
333 __u32 i_dtime; /* Deletion Time */
334 __u16 i_gid; /* Low 16 bits of Group Id */
335 __u16 i_links_count; /* Links count */
336 __u32 i_blocks; /* Blocks count */
337 __u32 i_flags; /* File flags */
338 union {
339 struct {
340 __u32 l_i_reserved1;
341 } linux1;
342 struct {
343 __u32 h_i_translator;
344 } hurd1;
345 struct {
346 __u32 m_i_reserved1;
347 } masix1;
348 } osd1; /* OS dependent 1 */
349 __u32 i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
350 __u32 i_generation; /* File version (for NFS) */
351 __u32 i_file_acl; /* File ACL */
352 __u32 i_dir_acl; /* Directory ACL */
353 __u32 i_faddr; /* Fragment address */
354 union {
355 struct {
356 __u8 l_i_frag; /* Fragment number */
357 __u8 l_i_fsize; /* Fragment size */
358 __u16 i_pad1;
359 __u16 l_i_uid_high; /* these 2 fields */
360 __u16 l_i_gid_high; /* were reserved2[0] */
361 __u32 l_i_reserved2;
362 } linux2;
363 struct {
364 __u8 h_i_frag; /* Fragment number */
365 __u8 h_i_fsize; /* Fragment size */
366 __u16 h_i_mode_high;
367 __u16 h_i_uid_high;
368 __u16 h_i_gid_high;
369 __u32 h_i_author;
370 } hurd2;
371 struct {
372 __u8 m_i_frag; /* Fragment number */
373 __u8 m_i_fsize; /* Fragment size */
374 __u16 m_pad1;
375 __u32 m_i_reserved2[2];
376 } masix2;
377 } osd2; /* OS dependent 2 */
378 __u16 i_extra_isize;
379 __u16 i_pad1;
380};
381
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000382#define i_size_high i_dir_acl
383
384#if defined(__KERNEL__) || defined(__linux__)
385#define i_reserved1 osd1.linux1.l_i_reserved1
386#define i_frag osd2.linux2.l_i_frag
387#define i_fsize osd2.linux2.l_i_fsize
388#define i_uid_low i_uid
389#define i_gid_low i_gid
390#define i_uid_high osd2.linux2.l_i_uid_high
391#define i_gid_high osd2.linux2.l_i_gid_high
392#define i_reserved2 osd2.linux2.l_i_reserved2
393
Theodore Ts'o48e6e812003-07-06 00:36:48 -0400394#else
395#if defined(__GNU__)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000396
397#define i_translator osd1.hurd1.h_i_translator
398#define i_frag osd2.hurd2.h_i_frag;
399#define i_fsize osd2.hurd2.h_i_fsize;
400#define i_uid_high osd2.hurd2.h_i_uid_high
401#define i_gid_high osd2.hurd2.h_i_gid_high
402#define i_author osd2.hurd2.h_i_author
403
Theodore Ts'o48e6e812003-07-06 00:36:48 -0400404#else
405#if defined(__masix__)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000406
407#define i_reserved1 osd1.masix1.m_i_reserved1
408#define i_frag osd2.masix2.m_i_frag
409#define i_fsize osd2.masix2.m_i_fsize
410#define i_reserved2 osd2.masix2.m_i_reserved2
411
Theodore Ts'o48e6e812003-07-06 00:36:48 -0400412#endif /* __masix__ */
413#endif /* __GNU__ */
Andreas Dilger7da78ff2002-06-09 17:38:50 -0600414#endif /* defined(__KERNEL__) || defined(__linux__) */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000415
416/*
417 * File system states
418 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600419#define EXT2_VALID_FS 0x0001 /* Unmounted cleanly */
420#define EXT2_ERROR_FS 0x0002 /* Errors detected */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000421
422/*
423 * Mount flags
424 */
425#define EXT2_MOUNT_CHECK 0x0001 /* Do mount-time checks */
426#define EXT2_MOUNT_GRPID 0x0004 /* Create files with directory's group */
427#define EXT2_MOUNT_DEBUG 0x0008 /* Some debugging messages */
428#define EXT2_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
429#define EXT2_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
430#define EXT2_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
431#define EXT2_MOUNT_MINIX_DF 0x0080 /* Mimics the Minix statfs */
432#define EXT2_MOUNT_NO_UID32 0x0200 /* Disable 32-bit UIDs */
433
434#define clear_opt(o, opt) o &= ~EXT2_MOUNT_##opt
435#define set_opt(o, opt) o |= EXT2_MOUNT_##opt
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600436#define test_opt(sb, opt) (EXT2_SB(sb)->s_mount_opt & \
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000437 EXT2_MOUNT_##opt)
438/*
439 * Maximal mount counts between two filesystem checks
440 */
441#define EXT2_DFL_MAX_MNT_COUNT 20 /* Allow 20 mounts */
442#define EXT2_DFL_CHECKINTERVAL 0 /* Don't use interval check */
443
444/*
445 * Behaviour when detecting errors
446 */
447#define EXT2_ERRORS_CONTINUE 1 /* Continue execution */
448#define EXT2_ERRORS_RO 2 /* Remount fs read-only */
449#define EXT2_ERRORS_PANIC 3 /* Panic */
450#define EXT2_ERRORS_DEFAULT EXT2_ERRORS_CONTINUE
451
452/*
453 * Structure of the super block
454 */
455struct ext2_super_block {
456 __u32 s_inodes_count; /* Inodes count */
457 __u32 s_blocks_count; /* Blocks count */
458 __u32 s_r_blocks_count; /* Reserved blocks count */
459 __u32 s_free_blocks_count; /* Free blocks count */
460 __u32 s_free_inodes_count; /* Free inodes count */
461 __u32 s_first_data_block; /* First Data Block */
462 __u32 s_log_block_size; /* Block size */
463 __s32 s_log_frag_size; /* Fragment size */
464 __u32 s_blocks_per_group; /* # Blocks per group */
465 __u32 s_frags_per_group; /* # Fragments per group */
466 __u32 s_inodes_per_group; /* # Inodes per group */
467 __u32 s_mtime; /* Mount time */
468 __u32 s_wtime; /* Write time */
469 __u16 s_mnt_count; /* Mount count */
470 __s16 s_max_mnt_count; /* Maximal mount count */
471 __u16 s_magic; /* Magic signature */
472 __u16 s_state; /* File system state */
473 __u16 s_errors; /* Behaviour when detecting errors */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600474 __u16 s_minor_rev_level; /* minor revision level */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000475 __u32 s_lastcheck; /* time of last check */
476 __u32 s_checkinterval; /* max. time between checks */
477 __u32 s_creator_os; /* OS */
478 __u32 s_rev_level; /* Revision level */
479 __u16 s_def_resuid; /* Default uid for reserved blocks */
480 __u16 s_def_resgid; /* Default gid for reserved blocks */
481 /*
482 * These fields are for EXT2_DYNAMIC_REV superblocks only.
483 *
484 * Note: the difference between the compatible feature set and
485 * the incompatible feature set is that if there is a bit set
486 * in the incompatible feature set that the kernel doesn't
487 * know about, it should refuse to mount the filesystem.
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600488 *
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000489 * e2fsck's requirements are more strict; if it doesn't know
490 * about a feature in either the compatible or incompatible
491 * feature set, it must abort and not try to meddle with
492 * things it doesn't understand...
493 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600494 __u32 s_first_ino; /* First non-reserved inode */
495 __u16 s_inode_size; /* size of inode structure */
496 __u16 s_block_group_nr; /* block group # of this superblock */
497 __u32 s_feature_compat; /* compatible feature set */
498 __u32 s_feature_incompat; /* incompatible feature set */
499 __u32 s_feature_ro_compat; /* readonly-compatible feature set */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000500 __u8 s_uuid[16]; /* 128-bit uuid for volume */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600501 char s_volume_name[16]; /* volume name */
502 char s_last_mounted[64]; /* directory where last mounted */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000503 __u32 s_algorithm_usage_bitmap; /* For compression */
504 /*
505 * Performance hints. Directory preallocation should only
506 * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
507 */
508 __u8 s_prealloc_blocks; /* Nr of blocks to try to preallocate*/
509 __u8 s_prealloc_dir_blocks; /* Nr to preallocate for dirs */
Theodore Ts'o9e6c5dd2002-07-09 11:08:10 -0400510 __u16 s_reserved_gdt_blocks; /* Per group table for online growth */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600511 /*
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000512 * Journaling support valid if EXT2_FEATURE_COMPAT_HAS_JOURNAL set.
513 */
514 __u8 s_journal_uuid[16]; /* uuid of journal superblock */
515 __u32 s_journal_inum; /* inode number of journal file */
516 __u32 s_journal_dev; /* device number of journal file */
517 __u32 s_last_orphan; /* start of list of inodes to delete */
Theodore Ts'ob7a00562002-07-20 00:28:07 -0400518 __u32 s_hash_seed[4]; /* HTREE hash seed */
519 __u8 s_def_hash_version; /* Default hash version to use */
Theodore Ts'oa435ec32003-08-21 00:40:26 -0400520 __u8 s_jnl_backup_type; /* Default type of journal backup */
Theodore Ts'ob7a00562002-07-20 00:28:07 -0400521 __u16 s_reserved_word_pad;
Theodore Ts'oa0c3fd52002-10-15 17:43:43 -0400522 __u32 s_default_mount_opts;
Theodore Ts'oc046ac72002-10-20 00:38:57 -0400523 __u32 s_first_meta_bg; /* First metablock group */
Theodore Ts'o9d2aefb2002-10-25 17:29:55 -0400524 __u32 s_mkfs_time; /* When the filesystem was created */
Theodore Ts'o1ba7a2f2004-01-30 01:48:06 -0500525 __u32 s_jnl_blocks[17]; /* Backup of the journal inode */
526 __u32 s_reserved[172]; /* Padding to the end of the block */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000527};
528
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000529/*
530 * Codes for operating systems
531 */
532#define EXT2_OS_LINUX 0
533#define EXT2_OS_HURD 1
534#define EXT2_OS_MASIX 2
535#define EXT2_OS_FREEBSD 3
536#define EXT2_OS_LITES 4
537
538/*
539 * Revision levels
540 */
541#define EXT2_GOOD_OLD_REV 0 /* The good old (original) format */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600542#define EXT2_DYNAMIC_REV 1 /* V2 format w/ dynamic inode sizes */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000543
544#define EXT2_CURRENT_REV EXT2_GOOD_OLD_REV
545#define EXT2_MAX_SUPP_REV EXT2_DYNAMIC_REV
546
547#define EXT2_GOOD_OLD_INODE_SIZE 128
548
549/*
Theodore Ts'oa435ec32003-08-21 00:40:26 -0400550 * Journal inode backup types
551 */
552#define EXT3_JNL_BACKUP_BLOCKS 1
553
554/*
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000555 * Feature set definitions
556 */
557
558#define EXT2_HAS_COMPAT_FEATURE(sb,mask) \
559 ( EXT2_SB(sb)->s_feature_compat & (mask) )
560#define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask) \
561 ( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
562#define EXT2_HAS_INCOMPAT_FEATURE(sb,mask) \
563 ( EXT2_SB(sb)->s_feature_incompat & (mask) )
564
565#define EXT2_FEATURE_COMPAT_DIR_PREALLOC 0x0001
566#define EXT2_FEATURE_COMPAT_IMAGIC_INODES 0x0002
567#define EXT3_FEATURE_COMPAT_HAS_JOURNAL 0x0004
Theodore Ts'ob10820c2001-05-21 05:23:31 +0000568#define EXT2_FEATURE_COMPAT_EXT_ATTR 0x0008
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000569#define EXT2_FEATURE_COMPAT_RESIZE_INODE 0x0010
Theodore Ts'ob10820c2001-05-21 05:23:31 +0000570#define EXT2_FEATURE_COMPAT_DIR_INDEX 0x0020
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000571
572#define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER 0x0001
573#define EXT2_FEATURE_RO_COMPAT_LARGE_FILE 0x0002
Theodore Ts'o2c931132003-04-11 13:26:21 -0400574/* #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR 0x0004 not used */
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000575
576#define EXT2_FEATURE_INCOMPAT_COMPRESSION 0x0001
577#define EXT2_FEATURE_INCOMPAT_FILETYPE 0x0002
578#define EXT3_FEATURE_INCOMPAT_RECOVER 0x0004 /* Needs recovery */
579#define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV 0x0008 /* Journal device */
Theodore Ts'oc046ac72002-10-20 00:38:57 -0400580#define EXT2_FEATURE_INCOMPAT_META_BG 0x0010
Theodore Ts'o39dc1c42004-11-29 22:14:23 -0500581#define EXT3_FEATURE_INCOMPAT_EXTENTS 0x0040
582
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000583
584#define EXT2_FEATURE_COMPAT_SUPP 0
Theodore Ts'oc046ac72002-10-20 00:38:57 -0400585#define EXT2_FEATURE_INCOMPAT_SUPP (EXT2_FEATURE_INCOMPAT_FILETYPE)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000586#define EXT2_FEATURE_RO_COMPAT_SUPP (EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
587 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
588 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
589
590/*
591 * Default values for user and/or group using reserved blocks
592 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600593#define EXT2_DEF_RESUID 0
594#define EXT2_DEF_RESGID 0
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000595
596/*
Theodore Ts'oa0c3fd52002-10-15 17:43:43 -0400597 * Default mount options
598 */
599#define EXT2_DEFM_DEBUG 0x0001
600#define EXT2_DEFM_BSDGROUPS 0x0002
601#define EXT2_DEFM_XATTR_USER 0x0004
602#define EXT2_DEFM_ACL 0x0008
603#define EXT2_DEFM_UID16 0x0010
Theodore Ts'o4a959fe2002-10-20 01:52:52 -0400604#define EXT3_DEFM_JMODE 0x0060
605#define EXT3_DEFM_JMODE_DATA 0x0020
606#define EXT3_DEFM_JMODE_ORDERED 0x0040
607#define EXT3_DEFM_JMODE_WBACK 0x0060
Theodore Ts'oa0c3fd52002-10-15 17:43:43 -0400608
609/*
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000610 * Structure of a directory entry
611 */
612#define EXT2_NAME_LEN 255
613
614struct ext2_dir_entry {
615 __u32 inode; /* Inode number */
616 __u16 rec_len; /* Directory entry length */
617 __u16 name_len; /* Name length */
618 char name[EXT2_NAME_LEN]; /* File name */
619};
620
621/*
622 * The new version of the directory entry. Since EXT2 structures are
623 * stored in intel byte order, and the name_len field could never be
624 * bigger than 255 chars, it's safe to reclaim the extra byte for the
625 * file_type field.
626 */
627struct ext2_dir_entry_2 {
628 __u32 inode; /* Inode number */
629 __u16 rec_len; /* Directory entry length */
630 __u8 name_len; /* Name length */
631 __u8 file_type;
632 char name[EXT2_NAME_LEN]; /* File name */
633};
634
635/*
636 * Ext2 directory file types. Only the low 3 bits are used. The
637 * other bits are reserved for now.
638 */
639#define EXT2_FT_UNKNOWN 0
640#define EXT2_FT_REG_FILE 1
641#define EXT2_FT_DIR 2
642#define EXT2_FT_CHRDEV 3
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600643#define EXT2_FT_BLKDEV 4
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000644#define EXT2_FT_FIFO 5
645#define EXT2_FT_SOCK 6
646#define EXT2_FT_SYMLINK 7
647
648#define EXT2_FT_MAX 8
649
650/*
651 * EXT2_DIR_PAD defines the directory entries boundaries
652 *
653 * NOTE: It must be a multiple of 4
654 */
Andreas Dilger0fbd1a82002-05-23 00:32:34 -0600655#define EXT2_DIR_PAD 4
656#define EXT2_DIR_ROUND (EXT2_DIR_PAD - 1)
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000657#define EXT2_DIR_REC_LEN(name_len) (((name_len) + 8 + EXT2_DIR_ROUND) & \
658 ~EXT2_DIR_ROUND)
659
Theodore Ts'o9f8046f2001-05-14 11:35:52 +0000660#endif /* _LINUX_EXT2_FS_H */