ext2_fs.h revision 6a6337c3df7c982eb888764d585ec483a51af16e
1/*
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
19#include <ext2fs/ext2_types.h>		/* Changed from linux/types.h */
20
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/*
43 * Special inode numbers
44 */
45#define EXT2_BAD_INO		 1	/* Bad blocks inode */
46#define EXT2_ROOT_INO		 2	/* Root inode */
47#define EXT4_USR_QUOTA_INO	 3	/* User quota inode */
48#define EXT4_GRP_QUOTA_INO	 4	/* Group quota 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#define EXT2_EXCLUDE_INO	 9	/* The "exclude" inode, for snapshots */
54
55/* First non-reserved inode for old ext2 filesystems */
56#define EXT2_GOOD_OLD_FIRST_INO	11
57
58/*
59 * The second extended file system magic number
60 */
61#define EXT2_SUPER_MAGIC	0xEF53
62
63#ifdef __KERNEL__
64#define EXT2_SB(sb)	(&((sb)->u.ext2_sb))
65#else
66/* Assume that user mode programs are passing in an ext2fs superblock, not
67 * a kernel struct super_block.  This will allow us to call the feature-test
68 * macros from user land. */
69#define EXT2_SB(sb)	(sb)
70#endif
71
72/*
73 * Maximal count of links to a file
74 */
75#define EXT2_LINK_MAX		65000
76
77/*
78 * Macro-instructions used to manage several block sizes
79 */
80#define EXT2_MIN_BLOCK_LOG_SIZE		10	/* 1024 */
81#define EXT2_MAX_BLOCK_LOG_SIZE		16	/* 65536 */
82#define EXT2_MIN_BLOCK_SIZE	(1 << EXT2_MIN_BLOCK_LOG_SIZE)
83#define EXT2_MAX_BLOCK_SIZE	(1 << EXT2_MAX_BLOCK_LOG_SIZE)
84#ifdef __KERNEL__
85#define EXT2_BLOCK_SIZE(s)	((s)->s_blocksize)
86#define EXT2_BLOCK_SIZE_BITS(s)	((s)->s_blocksize_bits)
87#define EXT2_ADDR_PER_BLOCK_BITS(s)	(EXT2_SB(s)->addr_per_block_bits)
88#define EXT2_INODE_SIZE(s)	(EXT2_SB(s)->s_inode_size)
89#define EXT2_FIRST_INO(s)	(EXT2_SB(s)->s_first_ino)
90#else
91#define EXT2_BLOCK_SIZE(s)	(EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
92#define EXT2_BLOCK_SIZE_BITS(s)	((s)->s_log_block_size + 10)
93#define EXT2_INODE_SIZE(s)	(((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
94				 EXT2_GOOD_OLD_INODE_SIZE : (s)->s_inode_size)
95#define EXT2_FIRST_INO(s)	(((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
96				 EXT2_GOOD_OLD_FIRST_INO : (s)->s_first_ino)
97#endif
98#define EXT2_ADDR_PER_BLOCK(s)	(EXT2_BLOCK_SIZE(s) / sizeof(__u32))
99
100/*
101 * Macro-instructions used to manage allocation clusters
102 */
103#define EXT2_MIN_CLUSTER_LOG_SIZE	EXT2_MIN_BLOCK_LOG_SIZE
104#define EXT2_MAX_CLUSTER_LOG_SIZE	29	/* 512MB  */
105#define EXT2_MIN_CLUSTER_SIZE		EXT2_MIN_BLOCK_SIZE
106#define EXT2_MAX_CLUSTER_SIZE		(1 << EXT2_MAX_CLUSTER_LOG_SIZE)
107#define EXT2_CLUSTER_SIZE(s)		(EXT2_MIN_BLOCK_SIZE << \
108						(s)->s_log_cluster_size)
109#define EXT2_CLUSTER_SIZE_BITS(s)	((s)->s_log_cluster_size + 10)
110
111/*
112 * ACL structures
113 */
114struct ext2_acl_header	/* Header of Access Control Lists */
115{
116	__u32	aclh_size;
117	__u32	aclh_file_count;
118	__u32	aclh_acle_count;
119	__u32	aclh_first_acle;
120};
121
122struct ext2_acl_entry	/* Access Control List Entry */
123{
124	__u32	acle_size;
125	__u16	acle_perms;	/* Access permissions */
126	__u16	acle_type;	/* Type of entry */
127	__u16	acle_tag;	/* User or group identity */
128	__u16	acle_pad1;
129	__u32	acle_next;	/* Pointer on next entry for the */
130					/* same inode or on next free entry */
131};
132
133/*
134 * Structure of a blocks group descriptor
135 */
136struct ext2_group_desc
137{
138	__u32	bg_block_bitmap;	/* Blocks bitmap block */
139	__u32	bg_inode_bitmap;	/* Inodes bitmap block */
140	__u32	bg_inode_table;		/* Inodes table block */
141	__u16	bg_free_blocks_count;	/* Free blocks count */
142	__u16	bg_free_inodes_count;	/* Free inodes count */
143	__u16	bg_used_dirs_count;	/* Directories count */
144	__u16	bg_flags;
145	__u32	bg_reserved[2];
146	__u16	bg_itable_unused;	/* Unused inodes count */
147	__u16	bg_checksum;		/* crc16(s_uuid+grouo_num+group_desc)*/
148};
149
150/*
151 * Structure of a blocks group descriptor
152 */
153struct ext4_group_desc
154{
155	__u32	bg_block_bitmap;	/* Blocks bitmap block */
156	__u32	bg_inode_bitmap;	/* Inodes bitmap block */
157	__u32	bg_inode_table;		/* Inodes table block */
158	__u16	bg_free_blocks_count;	/* Free blocks count */
159	__u16	bg_free_inodes_count;	/* Free inodes count */
160	__u16	bg_used_dirs_count;	/* Directories count */
161	__u16	bg_flags;		/* EXT4_BG_flags (INODE_UNINIT, etc) */
162	__u32	bg_reserved[2];		/* Likely block/inode bitmap checksum */
163	__u16	bg_itable_unused;	/* Unused inodes count */
164	__u16	bg_checksum;		/* crc16(sb_uuid+group+desc) */
165	__u32	bg_block_bitmap_hi;	/* Blocks bitmap block MSB */
166	__u32	bg_inode_bitmap_hi;	/* Inodes bitmap block MSB */
167	__u32	bg_inode_table_hi;	/* Inodes table block MSB */
168	__u16	bg_free_blocks_count_hi;/* Free blocks count MSB */
169	__u16	bg_free_inodes_count_hi;/* Free inodes count MSB */
170	__u16	bg_used_dirs_count_hi;	/* Directories count MSB */
171	__u16	bg_itable_unused_hi;	/* Unused inodes count MSB */
172	__u32	bg_reserved2[3];
173};
174
175#define EXT2_BG_INODE_UNINIT	0x0001 /* Inode table/bitmap not initialized */
176#define EXT2_BG_BLOCK_UNINIT	0x0002 /* Block bitmap not initialized */
177#define EXT2_BG_INODE_ZEROED	0x0004 /* On-disk itable initialized to zero */
178
179/*
180 * Data structures used by the directory indexing feature
181 *
182 * Note: all of the multibyte integer fields are little endian.
183 */
184
185/*
186 * Note: dx_root_info is laid out so that if it should somehow get
187 * overlaid by a dirent the two low bits of the hash version will be
188 * zero.  Therefore, the hash version mod 4 should never be 0.
189 * Sincerely, the paranoia department.
190 */
191struct ext2_dx_root_info {
192	__u32 reserved_zero;
193	__u8 hash_version; /* 0 now, 1 at release */
194	__u8 info_length; /* 8 */
195	__u8 indirect_levels;
196	__u8 unused_flags;
197};
198
199#define EXT2_HASH_LEGACY		0
200#define EXT2_HASH_HALF_MD4		1
201#define EXT2_HASH_TEA			2
202#define EXT2_HASH_LEGACY_UNSIGNED	3 /* reserved for userspace lib */
203#define EXT2_HASH_HALF_MD4_UNSIGNED	4 /* reserved for userspace lib */
204#define EXT2_HASH_TEA_UNSIGNED		5 /* reserved for userspace lib */
205
206#define EXT2_HASH_FLAG_INCOMPAT	0x1
207
208struct ext2_dx_entry {
209	__u32 hash;
210	__u32 block;
211};
212
213struct ext2_dx_countlimit {
214	__u16 limit;
215	__u16 count;
216};
217
218
219/*
220 * Macro-instructions used to manage group descriptors
221 */
222#define EXT2_MIN_DESC_SIZE             32
223#define EXT2_MIN_DESC_SIZE_64BIT       64
224#define EXT2_MAX_DESC_SIZE             EXT2_MIN_BLOCK_SIZE
225#define EXT2_DESC_SIZE(s)                                                \
226       ((EXT2_SB(s)->s_feature_incompat & EXT4_FEATURE_INCOMPAT_64BIT) ? \
227	(s)->s_desc_size : EXT2_MIN_DESC_SIZE)
228
229#define EXT2_BLOCKS_PER_GROUP(s)	(EXT2_SB(s)->s_blocks_per_group)
230#define EXT2_INODES_PER_GROUP(s)	(EXT2_SB(s)->s_inodes_per_group)
231#define EXT2_CLUSTERS_PER_GROUP(s)	(EXT2_SB(s)->s_clusters_per_group)
232#define EXT2_INODES_PER_BLOCK(s)	(EXT2_BLOCK_SIZE(s)/EXT2_INODE_SIZE(s))
233/* limits imposed by 16-bit value gd_free_{blocks,inode}_count */
234#define EXT2_MAX_BLOCKS_PER_GROUP(s)	(((1 << 16) - 8) *	\
235					 (EXT2_CLUSTER_SIZE(s) / \
236					  EXT2_BLOCK_SIZE(s)))
237#define EXT2_MAX_CLUSTERS_PER_GROUP(s)	((1 << 16) - 8)
238#define EXT2_MAX_INODES_PER_GROUP(s)	((1 << 16) - EXT2_INODES_PER_BLOCK(s))
239#ifdef __KERNEL__
240#define EXT2_DESC_PER_BLOCK(s)		(EXT2_SB(s)->s_desc_per_block)
241#define EXT2_DESC_PER_BLOCK_BITS(s)	(EXT2_SB(s)->s_desc_per_block_bits)
242#else
243#define EXT2_DESC_PER_BLOCK(s)		(EXT2_BLOCK_SIZE(s) / EXT2_DESC_SIZE(s))
244#endif
245
246/*
247 * Constants relative to the data blocks
248 */
249#define EXT2_NDIR_BLOCKS		12
250#define EXT2_IND_BLOCK			EXT2_NDIR_BLOCKS
251#define EXT2_DIND_BLOCK			(EXT2_IND_BLOCK + 1)
252#define EXT2_TIND_BLOCK			(EXT2_DIND_BLOCK + 1)
253#define EXT2_N_BLOCKS			(EXT2_TIND_BLOCK + 1)
254
255/*
256 * Inode flags
257 */
258#define EXT2_SECRM_FL			0x00000001 /* Secure deletion */
259#define EXT2_UNRM_FL			0x00000002 /* Undelete */
260#define EXT2_COMPR_FL			0x00000004 /* Compress file */
261#define EXT2_SYNC_FL			0x00000008 /* Synchronous updates */
262#define EXT2_IMMUTABLE_FL		0x00000010 /* Immutable file */
263#define EXT2_APPEND_FL			0x00000020 /* writes to file may only append */
264#define EXT2_NODUMP_FL			0x00000040 /* do not dump file */
265#define EXT2_NOATIME_FL			0x00000080 /* do not update atime */
266/* Reserved for compression usage... */
267#define EXT2_DIRTY_FL			0x00000100
268#define EXT2_COMPRBLK_FL		0x00000200 /* One or more compressed clusters */
269#define EXT2_NOCOMPR_FL			0x00000400 /* Access raw compressed data */
270#define EXT2_ECOMPR_FL			0x00000800 /* Compression error */
271/* End compression flags --- maybe not all used */
272#define EXT2_BTREE_FL			0x00001000 /* btree format dir */
273#define EXT2_INDEX_FL			0x00001000 /* hash-indexed directory */
274#define EXT2_IMAGIC_FL			0x00002000
275#define EXT3_JOURNAL_DATA_FL		0x00004000 /* file data should be journaled */
276#define EXT2_NOTAIL_FL			0x00008000 /* file tail should not be merged */
277#define EXT2_DIRSYNC_FL 		0x00010000 /* Synchronous directory modifications */
278#define EXT2_TOPDIR_FL			0x00020000 /* Top of directory hierarchies*/
279#define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
280#define EXT4_EXTENTS_FL 		0x00080000 /* Inode uses extents */
281#define EXT4_EA_INODE_FL	        0x00200000 /* Inode used for large EA */
282#define EXT4_EOFBLOCKS_FL		0x00400000 /* Blocks allocated beyond EOF */
283#define EXT4_SNAPFILE_FL		0x01000000  /* Inode is a snapshot */
284#define EXT4_SNAPFILE_DELETED_FL	0x04000000  /* Snapshot is being deleted */
285#define EXT4_SNAPFILE_SHRUNK_FL		0x08000000  /* Snapshot shrink has completed */
286#define EXT2_RESERVED_FL		0x80000000 /* reserved for ext2 lib */
287
288#define EXT2_FL_USER_VISIBLE		0x004BDFFF /* User visible flags */
289#define EXT2_FL_USER_MODIFIABLE		0x004B80FF /* User modifiable flags */
290
291/*
292 * ioctl commands
293 */
294
295/* Used for online resize */
296struct ext2_new_group_input {
297	__u32 group;		/* Group number for this data */
298	__u32 block_bitmap;	/* Absolute block number of block bitmap */
299	__u32 inode_bitmap;	/* Absolute block number of inode bitmap */
300	__u32 inode_table;	/* Absolute block number of inode table start */
301	__u32 blocks_count;	/* Total number of blocks in this group */
302	__u16 reserved_blocks;	/* Number of reserved blocks in this group */
303	__u16 unused;		/* Number of reserved GDT blocks in group */
304};
305
306struct ext4_new_group_input {
307	__u32 group;		/* Group number for this data */
308	__u64 block_bitmap;	/* Absolute block number of block bitmap */
309	__u64 inode_bitmap;	/* Absolute block number of inode bitmap */
310	__u64 inode_table;	/* Absolute block number of inode table start */
311	__u32 blocks_count;	/* Total number of blocks in this group */
312	__u16 reserved_blocks;	/* Number of reserved blocks in this group */
313	__u16 unused;
314};
315
316#ifdef __GNU__			/* Needed for the Hurd */
317#define _IOT_ext2_new_group_input _IOT (_IOTS(__u32), 5, _IOTS(__u16), 2, 0, 0)
318#endif
319
320#define EXT2_IOC_GETFLAGS		_IOR('f', 1, long)
321#define EXT2_IOC_SETFLAGS		_IOW('f', 2, long)
322#define EXT2_IOC_GETVERSION		_IOR('v', 1, long)
323#define EXT2_IOC_SETVERSION		_IOW('v', 2, long)
324#define EXT2_IOC_GETVERSION_NEW		_IOR('f', 3, long)
325#define EXT2_IOC_SETVERSION_NEW		_IOW('f', 4, long)
326#define EXT2_IOC_GROUP_EXTEND		_IOW('f', 7, unsigned long)
327#define EXT2_IOC_GROUP_ADD		_IOW('f', 8,struct ext2_new_group_input)
328#define EXT4_IOC_GROUP_ADD		_IOW('f', 8,struct ext4_new_group_input)
329
330/*
331 * Structure of an inode on the disk
332 */
333struct ext2_inode {
334	__u16	i_mode;		/* File mode */
335	__u16	i_uid;		/* Low 16 bits of Owner Uid */
336	__u32	i_size;		/* Size in bytes */
337	__u32	i_atime;	/* Access time */
338	__u32	i_ctime;	/* Inode change time */
339	__u32	i_mtime;	/* Modification time */
340	__u32	i_dtime;	/* Deletion Time */
341	__u16	i_gid;		/* Low 16 bits of Group Id */
342	__u16	i_links_count;	/* Links count */
343	__u32	i_blocks;	/* Blocks count */
344	__u32	i_flags;	/* File flags */
345	union {
346		struct {
347			__u32	l_i_version; /* was l_i_reserved1 */
348		} linux1;
349		struct {
350			__u32  h_i_translator;
351		} hurd1;
352	} osd1;				/* OS dependent 1 */
353	__u32	i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
354	__u32	i_generation;	/* File version (for NFS) */
355	__u32	i_file_acl;	/* File ACL */
356	__u32	i_size_high;	/* Formerly i_dir_acl, directory ACL */
357	__u32	i_faddr;	/* Fragment address */
358	union {
359		struct {
360			__u16	l_i_blocks_hi;
361			__u16	l_i_file_acl_high;
362			__u16	l_i_uid_high;	/* these 2 fields    */
363			__u16	l_i_gid_high;	/* were reserved2[0] */
364			__u32	l_i_reserved2;
365		} linux2;
366		struct {
367			__u8	h_i_frag;	/* Fragment number */
368			__u8	h_i_fsize;	/* Fragment size */
369			__u16	h_i_mode_high;
370			__u16	h_i_uid_high;
371			__u16	h_i_gid_high;
372			__u32	h_i_author;
373		} hurd2;
374	} osd2;				/* OS dependent 2 */
375};
376
377/*
378 * Permanent part of an large inode on the disk
379 */
380struct ext2_inode_large {
381	__u16	i_mode;		/* File mode */
382	__u16	i_uid;		/* Low 16 bits of Owner Uid */
383	__u32	i_size;		/* Size in bytes */
384	__u32	i_atime;	/* Access time */
385	__u32	i_ctime;	/* Inode Change time */
386	__u32	i_mtime;	/* Modification time */
387	__u32	i_dtime;	/* Deletion Time */
388	__u16	i_gid;		/* Low 16 bits of Group Id */
389	__u16	i_links_count;	/* Links count */
390	__u32	i_blocks;	/* Blocks count */
391	__u32	i_flags;	/* File flags */
392	union {
393		struct {
394			__u32	l_i_version; /* was l_i_reserved1 */
395		} linux1;
396		struct {
397			__u32  h_i_translator;
398		} hurd1;
399	} osd1;				/* OS dependent 1 */
400	__u32	i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
401	__u32	i_generation;	/* File version (for NFS) */
402	__u32	i_file_acl;	/* File ACL */
403	__u32	i_size_high;	/* Formerly i_dir_acl, directory ACL */
404	__u32	i_faddr;	/* Fragment address */
405	union {
406		struct {
407			__u16	l_i_blocks_hi;
408			__u16	l_i_file_acl_high;
409			__u16	l_i_uid_high;	/* these 2 fields    */
410			__u16	l_i_gid_high;	/* were reserved2[0] */
411			__u32	l_i_reserved2;
412		} linux2;
413		struct {
414			__u8	h_i_frag;	/* Fragment number */
415			__u8	h_i_fsize;	/* Fragment size */
416			__u16	h_i_mode_high;
417			__u16	h_i_uid_high;
418			__u16	h_i_gid_high;
419			__u32	h_i_author;
420		} hurd2;
421	} osd2;				/* OS dependent 2 */
422	__u16	i_extra_isize;
423	__u16	i_pad1;
424	__u32	i_ctime_extra;	/* extra Change time (nsec << 2 | epoch) */
425	__u32	i_mtime_extra;	/* extra Modification time (nsec << 2 | epoch) */
426	__u32	i_atime_extra;	/* extra Access time (nsec << 2 | epoch) */
427	__u32	i_crtime;	/* File creation time */
428	__u32	i_crtime_extra;	/* extra File creation time (nsec << 2 | epoch)*/
429	__u32	i_version_hi;	/* high 32 bits for 64-bit version */
430};
431
432#define i_dir_acl	i_size_high
433
434#if defined(__KERNEL__) || defined(__linux__)
435#define i_reserved1	osd1.linux1.l_i_reserved1
436#define i_frag		osd2.linux2.l_i_frag
437#define i_fsize		osd2.linux2.l_i_fsize
438#define i_uid_low	i_uid
439#define i_gid_low	i_gid
440#define i_uid_high	osd2.linux2.l_i_uid_high
441#define i_gid_high	osd2.linux2.l_i_gid_high
442#define i_reserved2	osd2.linux2.l_i_reserved2
443#else
444#if defined(__GNU__)
445
446#define i_translator	osd1.hurd1.h_i_translator
447#define i_frag		osd2.hurd2.h_i_frag;
448#define i_fsize		osd2.hurd2.h_i_fsize;
449#define i_uid_high	osd2.hurd2.h_i_uid_high
450#define i_gid_high	osd2.hurd2.h_i_gid_high
451#define i_author	osd2.hurd2.h_i_author
452
453#endif  /* __GNU__ */
454#endif	/* defined(__KERNEL__) || defined(__linux__) */
455
456#define inode_uid(inode)	((inode).i_uid | (inode).osd2.linux2.l_i_uid_high << 16)
457#define inode_gid(inode)	((inode).i_gid | (inode).osd2.linux2.l_i_gid_high << 16)
458#define ext2fs_set_i_uid_high(inode,x) ((inode).osd2.linux2.l_i_uid_high = (x))
459#define ext2fs_set_i_gid_high(inode,x) ((inode).osd2.linux2.l_i_gid_high = (x))
460
461/*
462 * File system states
463 */
464#define EXT2_VALID_FS			0x0001	/* Unmounted cleanly */
465#define EXT2_ERROR_FS			0x0002	/* Errors detected */
466#define EXT3_ORPHAN_FS			0x0004	/* Orphans being recovered */
467
468/*
469 * Misc. filesystem flags
470 */
471#define EXT2_FLAGS_SIGNED_HASH		0x0001  /* Signed dirhash in use */
472#define EXT2_FLAGS_UNSIGNED_HASH	0x0002  /* Unsigned dirhash in use */
473#define EXT2_FLAGS_TEST_FILESYS		0x0004	/* OK for use on development code */
474#define EXT2_FLAGS_IS_SNAPSHOT		0x0010	/* This is a snapshot image */
475#define EXT2_FLAGS_FIX_SNAPSHOT		0x0020	/* Snapshot inodes corrupted */
476#define EXT2_FLAGS_FIX_EXCLUDE		0x0040	/* Exclude bitmaps corrupted */
477
478/*
479 * Mount flags
480 */
481#define EXT2_MOUNT_CHECK		0x0001	/* Do mount-time checks */
482#define EXT2_MOUNT_GRPID		0x0004	/* Create files with directory's group */
483#define EXT2_MOUNT_DEBUG		0x0008	/* Some debugging messages */
484#define EXT2_MOUNT_ERRORS_CONT		0x0010	/* Continue on errors */
485#define EXT2_MOUNT_ERRORS_RO		0x0020	/* Remount fs ro on errors */
486#define EXT2_MOUNT_ERRORS_PANIC		0x0040	/* Panic on errors */
487#define EXT2_MOUNT_MINIX_DF		0x0080	/* Mimics the Minix statfs */
488#define EXT2_MOUNT_NO_UID32		0x0200  /* Disable 32-bit UIDs */
489
490#define clear_opt(o, opt)		o &= ~EXT2_MOUNT_##opt
491#define set_opt(o, opt)			o |= EXT2_MOUNT_##opt
492#define test_opt(sb, opt)		(EXT2_SB(sb)->s_mount_opt & \
493					 EXT2_MOUNT_##opt)
494/*
495 * Maximal mount counts between two filesystem checks
496 */
497#define EXT2_DFL_MAX_MNT_COUNT		20	/* Allow 20 mounts */
498#define EXT2_DFL_CHECKINTERVAL		0	/* Don't use interval check */
499
500/*
501 * Behaviour when detecting errors
502 */
503#define EXT2_ERRORS_CONTINUE		1	/* Continue execution */
504#define EXT2_ERRORS_RO			2	/* Remount fs read-only */
505#define EXT2_ERRORS_PANIC		3	/* Panic */
506#define EXT2_ERRORS_DEFAULT		EXT2_ERRORS_CONTINUE
507
508#if (__GNUC__ >= 4)
509#define ext4_offsetof(TYPE,MEMBER) __builtin_offsetof(TYPE,MEMBER)
510#else
511#define ext4_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
512#endif
513
514/*
515 * Structure of the super block
516 */
517struct ext2_super_block {
518	__u32	s_inodes_count;		/* Inodes count */
519	__u32	s_blocks_count;		/* Blocks count */
520	__u32	s_r_blocks_count;	/* Reserved blocks count */
521	__u32	s_free_blocks_count;	/* Free blocks count */
522	__u32	s_free_inodes_count;	/* Free inodes count */
523	__u32	s_first_data_block;	/* First Data Block */
524	__u32	s_log_block_size;	/* Block size */
525	__u32	s_log_cluster_size;	/* Allocation cluster size */
526	__u32	s_blocks_per_group;	/* # Blocks per group */
527	__u32	s_clusters_per_group;	/* # Fragments per group */
528	__u32	s_inodes_per_group;	/* # Inodes per group */
529	__u32	s_mtime;		/* Mount time */
530	__u32	s_wtime;		/* Write time */
531	__u16	s_mnt_count;		/* Mount count */
532	__s16	s_max_mnt_count;	/* Maximal mount count */
533	__u16	s_magic;		/* Magic signature */
534	__u16	s_state;		/* File system state */
535	__u16	s_errors;		/* Behaviour when detecting errors */
536	__u16	s_minor_rev_level;	/* minor revision level */
537	__u32	s_lastcheck;		/* time of last check */
538	__u32	s_checkinterval;	/* max. time between checks */
539	__u32	s_creator_os;		/* OS */
540	__u32	s_rev_level;		/* Revision level */
541	__u16	s_def_resuid;		/* Default uid for reserved blocks */
542	__u16	s_def_resgid;		/* Default gid for reserved blocks */
543	/*
544	 * These fields are for EXT2_DYNAMIC_REV superblocks only.
545	 *
546	 * Note: the difference between the compatible feature set and
547	 * the incompatible feature set is that if there is a bit set
548	 * in the incompatible feature set that the kernel doesn't
549	 * know about, it should refuse to mount the filesystem.
550	 *
551	 * e2fsck's requirements are more strict; if it doesn't know
552	 * about a feature in either the compatible or incompatible
553	 * feature set, it must abort and not try to meddle with
554	 * things it doesn't understand...
555	 */
556	__u32	s_first_ino;		/* First non-reserved inode */
557	__u16   s_inode_size;		/* size of inode structure */
558	__u16	s_block_group_nr;	/* block group # of this superblock */
559	__u32	s_feature_compat;	/* compatible feature set */
560	__u32	s_feature_incompat;	/* incompatible feature set */
561	__u32	s_feature_ro_compat;	/* readonly-compatible feature set */
562	__u8	s_uuid[16];		/* 128-bit uuid for volume */
563	char	s_volume_name[16];	/* volume name */
564	char	s_last_mounted[64];	/* directory where last mounted */
565	__u32	s_algorithm_usage_bitmap; /* For compression */
566	/*
567	 * Performance hints.  Directory preallocation should only
568	 * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
569	 */
570	__u8	s_prealloc_blocks;	/* Nr of blocks to try to preallocate*/
571	__u8	s_prealloc_dir_blocks;	/* Nr to preallocate for dirs */
572	__u16	s_reserved_gdt_blocks;	/* Per group table for online growth */
573	/*
574	 * Journaling support valid if EXT2_FEATURE_COMPAT_HAS_JOURNAL set.
575	 */
576	__u8	s_journal_uuid[16];	/* uuid of journal superblock */
577	__u32	s_journal_inum;		/* inode number of journal file */
578	__u32	s_journal_dev;		/* device number of journal file */
579	__u32	s_last_orphan;		/* start of list of inodes to delete */
580	__u32	s_hash_seed[4];		/* HTREE hash seed */
581	__u8	s_def_hash_version;	/* Default hash version to use */
582	__u8	s_jnl_backup_type; 	/* Default type of journal backup */
583	__u16	s_desc_size;		/* Group desc. size: INCOMPAT_64BIT */
584	__u32	s_default_mount_opts;
585	__u32	s_first_meta_bg;	/* First metablock group */
586	__u32	s_mkfs_time;		/* When the filesystem was created */
587	__u32	s_jnl_blocks[17]; 	/* Backup of the journal inode */
588	__u32	s_blocks_count_hi;	/* Blocks count high 32bits */
589	__u32	s_r_blocks_count_hi;	/* Reserved blocks count high 32 bits*/
590	__u32	s_free_blocks_hi; 	/* Free blocks count */
591	__u16	s_min_extra_isize;	/* All inodes have at least # bytes */
592	__u16	s_want_extra_isize; 	/* New inodes should reserve # bytes */
593	__u32	s_flags;		/* Miscellaneous flags */
594	__u16   s_raid_stride;		/* RAID stride */
595	__u16   s_mmp_interval;         /* # seconds to wait in MMP checking */
596	__u64   s_mmp_block;            /* Block for multi-mount protection */
597	__u32   s_raid_stripe_width;    /* blocks on all data disks (N*stride)*/
598	__u8	s_log_groups_per_flex;	/* FLEX_BG group size */
599	__u8    s_reserved_char_pad;
600	__u16	s_reserved_pad;		/* Padding to next 32bits */
601	__u64	s_kbytes_written;	/* nr of lifetime kilobytes written */
602	__u32	s_snapshot_inum;	/* Inode number of active snapshot */
603	__u32	s_snapshot_id;		/* sequential ID of active snapshot */
604	__u64	s_snapshot_r_blocks_count; /* reserved blocks for active
605					      snapshot's future use */
606	__u32	s_snapshot_list;	/* inode number of the head of the on-disk snapshot list */
607#define EXT4_S_ERR_START ext4_offsetof(struct ext2_super_block, s_error_count)
608	__u32	s_error_count;		/* number of fs errors */
609	__u32	s_first_error_time;	/* first time an error happened */
610	__u32	s_first_error_ino;	/* inode involved in first error */
611	__u64	s_first_error_block;	/* block involved of first error */
612	__u8	s_first_error_func[32];	/* function where the error happened */
613	__u32	s_first_error_line;	/* line number where error happened */
614	__u32	s_last_error_time;	/* most recent time of an error */
615	__u32	s_last_error_ino;	/* inode involved in last error */
616	__u32	s_last_error_line;	/* line number where error happened */
617	__u64	s_last_error_block;	/* block involved of last error */
618	__u8	s_last_error_func[32];	/* function where the error happened */
619#define EXT4_S_ERR_END ext4_offsetof(struct ext2_super_block, s_mount_opts)
620	__u8	s_mount_opts[64];
621	__u32	s_usr_quota_inum;	/* inode number of user quota file */
622	__u32	s_grp_quota_inum;	/* inode number of group quota file */
623	__u32	s_overhead_blocks;	/* overhead blocks/clusters in fs */
624	__u32   s_reserved[109];        /* Padding to the end of the block */
625};
626
627#define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
628
629/*
630 * Codes for operating systems
631 */
632#define EXT2_OS_LINUX		0
633#define EXT2_OS_HURD		1
634#define EXT2_OBSO_OS_MASIX	2
635#define EXT2_OS_FREEBSD		3
636#define EXT2_OS_LITES		4
637
638/*
639 * Revision levels
640 */
641#define EXT2_GOOD_OLD_REV	0	/* The good old (original) format */
642#define EXT2_DYNAMIC_REV	1	/* V2 format w/ dynamic inode sizes */
643
644#define EXT2_CURRENT_REV	EXT2_GOOD_OLD_REV
645#define EXT2_MAX_SUPP_REV	EXT2_DYNAMIC_REV
646
647#define EXT2_GOOD_OLD_INODE_SIZE 128
648
649/*
650 * Journal inode backup types
651 */
652#define EXT3_JNL_BACKUP_BLOCKS	1
653
654/*
655 * Feature set definitions
656 */
657
658#define EXT2_HAS_COMPAT_FEATURE(sb,mask)			\
659	( EXT2_SB(sb)->s_feature_compat & (mask) )
660#define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask)			\
661	( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
662#define EXT2_HAS_INCOMPAT_FEATURE(sb,mask)			\
663	( EXT2_SB(sb)->s_feature_incompat & (mask) )
664
665#define EXT2_FEATURE_COMPAT_DIR_PREALLOC	0x0001
666#define EXT2_FEATURE_COMPAT_IMAGIC_INODES	0x0002
667#define EXT3_FEATURE_COMPAT_HAS_JOURNAL		0x0004
668#define EXT2_FEATURE_COMPAT_EXT_ATTR		0x0008
669#define EXT2_FEATURE_COMPAT_RESIZE_INODE	0x0010
670#define EXT2_FEATURE_COMPAT_DIR_INDEX		0x0020
671#define EXT2_FEATURE_COMPAT_LAZY_BG		0x0040
672#define EXT2_FEATURE_COMPAT_EXCLUDE_INODE	0x0080
673
674#define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER	0x0001
675#define EXT2_FEATURE_RO_COMPAT_LARGE_FILE	0x0002
676/* #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR	0x0004 not used */
677#define EXT4_FEATURE_RO_COMPAT_HUGE_FILE	0x0008
678#define EXT4_FEATURE_RO_COMPAT_GDT_CSUM		0x0010
679#define EXT4_FEATURE_RO_COMPAT_DIR_NLINK	0x0020
680#define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE	0x0040
681#define EXT4_FEATURE_RO_COMPAT_HAS_SNAPSHOT	0x0080
682#define EXT4_FEATURE_RO_COMPAT_QUOTA		0x0100
683#define EXT4_FEATURE_RO_COMPAT_BIGALLOC		0x0200
684
685#define EXT2_FEATURE_INCOMPAT_COMPRESSION	0x0001
686#define EXT2_FEATURE_INCOMPAT_FILETYPE		0x0002
687#define EXT3_FEATURE_INCOMPAT_RECOVER		0x0004 /* Needs recovery */
688#define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV	0x0008 /* Journal device */
689#define EXT2_FEATURE_INCOMPAT_META_BG		0x0010
690#define EXT3_FEATURE_INCOMPAT_EXTENTS		0x0040
691#define EXT4_FEATURE_INCOMPAT_64BIT		0x0080
692#define EXT4_FEATURE_INCOMPAT_MMP		0x0100
693#define EXT4_FEATURE_INCOMPAT_FLEX_BG		0x0200
694#define EXT4_FEATURE_INCOMPAT_EA_INODE		0x0400
695#define EXT4_FEATURE_INCOMPAT_DIRDATA		0x1000
696
697#define EXT2_FEATURE_COMPAT_SUPP	0
698#define EXT2_FEATURE_INCOMPAT_SUPP	(EXT2_FEATURE_INCOMPAT_FILETYPE)
699#define EXT2_FEATURE_RO_COMPAT_SUPP	(EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
700					 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
701					 EXT4_FEATURE_RO_COMPAT_DIR_NLINK| \
702					 EXT2_FEATURE_RO_COMPAT_BTREE_DIR)
703
704/*
705 * Default values for user and/or group using reserved blocks
706 */
707#define EXT2_DEF_RESUID		0
708#define EXT2_DEF_RESGID		0
709
710/*
711 * Default mount options
712 */
713#define EXT2_DEFM_DEBUG		0x0001
714#define EXT2_DEFM_BSDGROUPS	0x0002
715#define EXT2_DEFM_XATTR_USER	0x0004
716#define EXT2_DEFM_ACL		0x0008
717#define EXT2_DEFM_UID16		0x0010
718#define EXT3_DEFM_JMODE		0x0060
719#define EXT3_DEFM_JMODE_DATA	0x0020
720#define EXT3_DEFM_JMODE_ORDERED	0x0040
721#define EXT3_DEFM_JMODE_WBACK	0x0060
722#define EXT4_DEFM_NOBARRIER	0x0100
723#define EXT4_DEFM_BLOCK_VALIDITY 0x0200
724#define EXT4_DEFM_DISCARD	0x0400
725#define EXT4_DEFM_NODELALLOC	0x0800
726
727/*
728 * Structure of a directory entry
729 */
730#define EXT2_NAME_LEN 255
731
732struct ext2_dir_entry {
733	__u32	inode;			/* Inode number */
734	__u16	rec_len;		/* Directory entry length */
735	__u16	name_len;		/* Name length */
736	char	name[EXT2_NAME_LEN];	/* File name */
737};
738
739/*
740 * The new version of the directory entry.  Since EXT2 structures are
741 * stored in intel byte order, and the name_len field could never be
742 * bigger than 255 chars, it's safe to reclaim the extra byte for the
743 * file_type field.
744 */
745struct ext2_dir_entry_2 {
746	__u32	inode;			/* Inode number */
747	__u16	rec_len;		/* Directory entry length */
748	__u8	name_len;		/* Name length */
749	__u8	file_type;
750	char	name[EXT2_NAME_LEN];	/* File name */
751};
752
753/*
754 * Ext2 directory file types.  Only the low 3 bits are used.  The
755 * other bits are reserved for now.
756 */
757#define EXT2_FT_UNKNOWN		0
758#define EXT2_FT_REG_FILE	1
759#define EXT2_FT_DIR		2
760#define EXT2_FT_CHRDEV		3
761#define EXT2_FT_BLKDEV		4
762#define EXT2_FT_FIFO		5
763#define EXT2_FT_SOCK		6
764#define EXT2_FT_SYMLINK		7
765
766#define EXT2_FT_MAX		8
767
768/*
769 * EXT2_DIR_PAD defines the directory entries boundaries
770 *
771 * NOTE: It must be a multiple of 4
772 */
773#define EXT2_DIR_PAD			4
774#define EXT2_DIR_ROUND			(EXT2_DIR_PAD - 1)
775#define EXT2_DIR_REC_LEN(name_len)	(((name_len) + 8 + EXT2_DIR_ROUND) & \
776					 ~EXT2_DIR_ROUND)
777
778/*
779 * This structure will be used for multiple mount protection. It will be
780 * written into the block number saved in the s_mmp_block field in the
781 * superblock.
782 */
783#define	EXT2_MMP_MAGIC    0x004D4D50 /* ASCII for MMP */
784#define	EXT2_MMP_CLEAN    0xFF4D4D50 /* Value of mmp_seq for clean unmount */
785#define	EXT2_MMP_FSCK_ON  0xE24D4D50 /* Value of mmp_seq when being fscked */
786
787struct mmp_struct {
788	__u32	mmp_magic;
789	__u32	mmp_seq;
790	__u64	mmp_time;
791	char	mmp_nodename[64];
792	char	mmp_bdevname[32];
793	__u16	mmp_interval;
794	__u16	mmp_pad1;
795	__u32	mmp_pad2;
796};
797
798/*
799 * Interval in number of seconds to update the MMP sequence number.
800 */
801#define EXT2_MMP_DEF_INTERVAL	5
802
803#endif	/* _LINUX_EXT2_FS_H */
804