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 #ifndef __GNUC_PREREQ
22 #if defined(__GNUC__) && defined(__GNUC_MINOR__)
23 #define __GNUC_PREREQ(maj, min) \
24 	((__GNUC__ << 16) + __GNUC_MINOR__ >= ((maj) << 16) + (min))
25 #else
26 #define __GNUC_PREREQ(maj, min) 0
27 #endif
28 #endif
29 
30 /*
31  * The second extended filesystem constants/structures
32  */
33 
34 /*
35  * Define EXT2FS_DEBUG to produce debug messages
36  */
37 #undef EXT2FS_DEBUG
38 
39 /*
40  * Define EXT2_PREALLOCATE to preallocate data blocks for expanding files
41  */
42 #define EXT2_PREALLOCATE
43 #define EXT2_DEFAULT_PREALLOC_BLOCKS	8
44 
45 /*
46  * The second extended file system version
47  */
48 #define EXT2FS_DATE		"95/08/09"
49 #define EXT2FS_VERSION		"0.5b"
50 
51 /*
52  * Special inode numbers
53  */
54 #define EXT2_BAD_INO		 1	/* Bad blocks inode */
55 #define EXT2_ROOT_INO		 2	/* Root inode */
56 #define EXT4_USR_QUOTA_INO	 3	/* User quota inode */
57 #define EXT4_GRP_QUOTA_INO	 4	/* Group quota inode */
58 #define EXT2_BOOT_LOADER_INO	 5	/* Boot loader inode */
59 #define EXT2_UNDEL_DIR_INO	 6	/* Undelete directory inode */
60 #define EXT2_RESIZE_INO		 7	/* Reserved group descriptors inode */
61 #define EXT2_JOURNAL_INO	 8	/* Journal inode */
62 #define EXT2_EXCLUDE_INO	 9	/* The "exclude" inode, for snapshots */
63 #define EXT4_REPLICA_INO	10	/* Used by non-upstream feature */
64 
65 /* First non-reserved inode for old ext2 filesystems */
66 #define EXT2_GOOD_OLD_FIRST_INO	11
67 
68 /*
69  * The second extended file system magic number
70  */
71 #define EXT2_SUPER_MAGIC	0xEF53
72 
73 #ifdef __KERNEL__
74 #define EXT2_SB(sb)	(&((sb)->u.ext2_sb))
75 #else
76 /* Assume that user mode programs are passing in an ext2fs superblock, not
77  * a kernel struct super_block.  This will allow us to call the feature-test
78  * macros from user land. */
79 #define EXT2_SB(sb)	(sb)
80 #endif
81 
82 /*
83  * Maximal count of links to a file
84  */
85 #define EXT2_LINK_MAX		65000
86 
87 /*
88  * Macro-instructions used to manage several block sizes
89  */
90 #define EXT2_MIN_BLOCK_LOG_SIZE		10	/* 1024 */
91 #define EXT2_MAX_BLOCK_LOG_SIZE		16	/* 65536 */
92 #define EXT2_MIN_BLOCK_SIZE	(1 << EXT2_MIN_BLOCK_LOG_SIZE)
93 #define EXT2_MAX_BLOCK_SIZE	(1 << EXT2_MAX_BLOCK_LOG_SIZE)
94 #ifdef __KERNEL__
95 #define EXT2_BLOCK_SIZE(s)	((s)->s_blocksize)
96 #define EXT2_BLOCK_SIZE_BITS(s)	((s)->s_blocksize_bits)
97 #define EXT2_ADDR_PER_BLOCK_BITS(s)	(EXT2_SB(s)->addr_per_block_bits)
98 #define EXT2_INODE_SIZE(s)	(EXT2_SB(s)->s_inode_size)
99 #define EXT2_FIRST_INO(s)	(EXT2_SB(s)->s_first_ino)
100 #else
101 #define EXT2_BLOCK_SIZE(s)	(EXT2_MIN_BLOCK_SIZE << (s)->s_log_block_size)
102 #define EXT2_BLOCK_SIZE_BITS(s)	((s)->s_log_block_size + 10)
103 #define EXT2_INODE_SIZE(s)	(((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
104 				 EXT2_GOOD_OLD_INODE_SIZE : (s)->s_inode_size)
105 #define EXT2_FIRST_INO(s)	(((s)->s_rev_level == EXT2_GOOD_OLD_REV) ? \
106 				 EXT2_GOOD_OLD_FIRST_INO : (s)->s_first_ino)
107 #endif
108 #define EXT2_ADDR_PER_BLOCK(s)	(EXT2_BLOCK_SIZE(s) / sizeof(__u32))
109 
110 /*
111  * Macro-instructions used to manage allocation clusters
112  */
113 #define EXT2_MIN_CLUSTER_LOG_SIZE	EXT2_MIN_BLOCK_LOG_SIZE
114 #define EXT2_MAX_CLUSTER_LOG_SIZE	29	/* 512MB  */
115 #define EXT2_MIN_CLUSTER_SIZE		EXT2_MIN_BLOCK_SIZE
116 #define EXT2_MAX_CLUSTER_SIZE		(1 << EXT2_MAX_CLUSTER_LOG_SIZE)
117 #define EXT2_CLUSTER_SIZE(s)		(EXT2_MIN_BLOCK_SIZE << \
118 						(s)->s_log_cluster_size)
119 #define EXT2_CLUSTER_SIZE_BITS(s)	((s)->s_log_cluster_size + 10)
120 
121 /*
122  * Macro-instructions used to manage fragments
123  *
124  * Note: for backwards compatibility only, for the dump program.
125  * Ext2/3/4 will never support fragments....
126  */
127 #define EXT2_MIN_FRAG_SIZE              EXT2_MIN_BLOCK_SIZE
128 #define EXT2_MAX_FRAG_SIZE              EXT2_MAX_BLOCK_SIZE
129 #define EXT2_MIN_FRAG_LOG_SIZE          EXT2_MIN_BLOCK_LOG_SIZE
130 #define EXT2_FRAG_SIZE(s)		EXT2_BLOCK_SIZE(s)
131 #define EXT2_FRAGS_PER_BLOCK(s)		1
132 
133 /*
134  * ACL structures
135  */
136 struct ext2_acl_header	/* Header of Access Control Lists */
137 {
138 	__u32	aclh_size;
139 	__u32	aclh_file_count;
140 	__u32	aclh_acle_count;
141 	__u32	aclh_first_acle;
142 };
143 
144 struct ext2_acl_entry	/* Access Control List Entry */
145 {
146 	__u32	acle_size;
147 	__u16	acle_perms;	/* Access permissions */
148 	__u16	acle_type;	/* Type of entry */
149 	__u16	acle_tag;	/* User or group identity */
150 	__u16	acle_pad1;
151 	__u32	acle_next;	/* Pointer on next entry for the */
152 					/* same inode or on next free entry */
153 };
154 
155 /*
156  * Structure of a blocks group descriptor
157  */
158 struct ext2_group_desc
159 {
160 	__u32	bg_block_bitmap;	/* Blocks bitmap block */
161 	__u32	bg_inode_bitmap;	/* Inodes bitmap block */
162 	__u32	bg_inode_table;		/* Inodes table block */
163 	__u16	bg_free_blocks_count;	/* Free blocks count */
164 	__u16	bg_free_inodes_count;	/* Free inodes count */
165 	__u16	bg_used_dirs_count;	/* Directories count */
166 	__u16	bg_flags;
167 	__u32	bg_exclude_bitmap_lo;	/* Exclude bitmap for snapshots */
168 	__u16	bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
169 	__u16	bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
170 	__u16	bg_itable_unused;	/* Unused inodes count */
171 	__u16	bg_checksum;		/* crc16(s_uuid+group_num+group_desc)*/
172 };
173 
174 /*
175  * Structure of a blocks group descriptor
176  */
177 struct ext4_group_desc
178 {
179 	__u32	bg_block_bitmap;	/* Blocks bitmap block */
180 	__u32	bg_inode_bitmap;	/* Inodes bitmap block */
181 	__u32	bg_inode_table;		/* Inodes table block */
182 	__u16	bg_free_blocks_count;	/* Free blocks count */
183 	__u16	bg_free_inodes_count;	/* Free inodes count */
184 	__u16	bg_used_dirs_count;	/* Directories count */
185 	__u16	bg_flags;		/* EXT4_BG_flags (INODE_UNINIT, etc) */
186 	__u32	bg_exclude_bitmap_lo;	/* Exclude bitmap for snapshots */
187 	__u16	bg_block_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
188 	__u16	bg_inode_bitmap_csum_lo;/* crc32c(s_uuid+grp_num+bitmap) LSB */
189 	__u16	bg_itable_unused;	/* Unused inodes count */
190 	__u16	bg_checksum;		/* crc16(sb_uuid+group+desc) */
191 	__u32	bg_block_bitmap_hi;	/* Blocks bitmap block MSB */
192 	__u32	bg_inode_bitmap_hi;	/* Inodes bitmap block MSB */
193 	__u32	bg_inode_table_hi;	/* Inodes table block MSB */
194 	__u16	bg_free_blocks_count_hi;/* Free blocks count MSB */
195 	__u16	bg_free_inodes_count_hi;/* Free inodes count MSB */
196 	__u16	bg_used_dirs_count_hi;	/* Directories count MSB */
197 	__u16	bg_itable_unused_hi;	/* Unused inodes count MSB */
198 	__u32	bg_exclude_bitmap_hi;	/* Exclude bitmap block MSB */
199 	__u16	bg_block_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
200 	__u16	bg_inode_bitmap_csum_hi;/* crc32c(s_uuid+grp_num+bitmap) MSB */
201 	__u32	bg_reserved;
202 };
203 
204 #define EXT4_BG_INODE_BITMAP_CSUM_HI_END	\
205 	(offsetof(struct ext4_group_desc, bg_inode_bitmap_csum_hi) + \
206 	 sizeof(__u16))
207 #define EXT4_BG_BLOCK_BITMAP_CSUM_HI_LOCATION	\
208 	(offsetof(struct ext4_group_desc, bg_block_bitmap_csum_hi) + \
209 	 sizeof(__u16))
210 
211 #define EXT2_BG_INODE_UNINIT	0x0001 /* Inode table/bitmap not initialized */
212 #define EXT2_BG_BLOCK_UNINIT	0x0002 /* Block bitmap not initialized */
213 #define EXT2_BG_INODE_ZEROED	0x0004 /* On-disk itable initialized to zero */
214 
215 /*
216  * Data structures used by the directory indexing feature
217  *
218  * Note: all of the multibyte integer fields are little endian.
219  */
220 
221 /*
222  * Note: dx_root_info is laid out so that if it should somehow get
223  * overlaid by a dirent the two low bits of the hash version will be
224  * zero.  Therefore, the hash version mod 4 should never be 0.
225  * Sincerely, the paranoia department.
226  */
227 struct ext2_dx_root_info {
228 	__u32 reserved_zero;
229 	__u8 hash_version; /* 0 now, 1 at release */
230 	__u8 info_length; /* 8 */
231 	__u8 indirect_levels;
232 	__u8 unused_flags;
233 };
234 
235 #define EXT2_HASH_LEGACY		0
236 #define EXT2_HASH_HALF_MD4		1
237 #define EXT2_HASH_TEA			2
238 #define EXT2_HASH_LEGACY_UNSIGNED	3 /* reserved for userspace lib */
239 #define EXT2_HASH_HALF_MD4_UNSIGNED	4 /* reserved for userspace lib */
240 #define EXT2_HASH_TEA_UNSIGNED		5 /* reserved for userspace lib */
241 
242 #define EXT2_HASH_FLAG_INCOMPAT	0x1
243 
244 #define EXT4_DX_BLOCK_MASK 0x0fffffff
245 
246 struct ext2_dx_entry {
247 	__le32 hash;
248 	__le32 block;
249 };
250 
251 struct ext2_dx_countlimit {
252 	__le16 limit;
253 	__le16 count;
254 };
255 
256 /*
257  * This goes at the end of each htree block.
258  */
259 struct ext2_dx_tail {
260 	__le32 dt_reserved;
261 	__le32 dt_checksum;	/* crc32c(uuid+inum+dxblock) */
262 };
263 
264 /*
265  * Macro-instructions used to manage group descriptors
266  */
267 #define EXT2_MIN_DESC_SIZE             32
268 #define EXT2_MIN_DESC_SIZE_64BIT       64
269 #define EXT2_MAX_DESC_SIZE             EXT2_MIN_BLOCK_SIZE
270 #define EXT2_DESC_SIZE(s)                                                \
271        ((EXT2_SB(s)->s_feature_incompat & EXT4_FEATURE_INCOMPAT_64BIT) ? \
272 	(s)->s_desc_size : EXT2_MIN_DESC_SIZE)
273 
274 #define EXT2_BLOCKS_PER_GROUP(s)	(EXT2_SB(s)->s_blocks_per_group)
275 #define EXT2_INODES_PER_GROUP(s)	(EXT2_SB(s)->s_inodes_per_group)
276 #define EXT2_CLUSTERS_PER_GROUP(s)	(EXT2_SB(s)->s_clusters_per_group)
277 #define EXT2_INODES_PER_BLOCK(s)	(EXT2_BLOCK_SIZE(s)/EXT2_INODE_SIZE(s))
278 /* limits imposed by 16-bit value gd_free_{blocks,inode}_count */
279 #define EXT2_MAX_BLOCKS_PER_GROUP(s)	((((unsigned) 1 << 16) - 8) *	\
280 					 (EXT2_CLUSTER_SIZE(s) / \
281 					  EXT2_BLOCK_SIZE(s)))
282 #define EXT2_MAX_CLUSTERS_PER_GROUP(s)	(((unsigned) 1 << 16) - 8)
283 #define EXT2_MAX_INODES_PER_GROUP(s)	(((unsigned) 1 << 16) - \
284 					 EXT2_INODES_PER_BLOCK(s))
285 #ifdef __KERNEL__
286 #define EXT2_DESC_PER_BLOCK(s)		(EXT2_SB(s)->s_desc_per_block)
287 #define EXT2_DESC_PER_BLOCK_BITS(s)	(EXT2_SB(s)->s_desc_per_block_bits)
288 #else
289 #define EXT2_DESC_PER_BLOCK(s)		(EXT2_BLOCK_SIZE(s) / EXT2_DESC_SIZE(s))
290 #endif
291 
292 #define EXT2_GROUPS_TO_BLOCKS(s, g)   ((blk64_t) EXT2_BLOCKS_PER_GROUP(s) * \
293 				       (g))
294 #define EXT2_GROUPS_TO_CLUSTERS(s, g) ((blk64_t) EXT2_CLUSTERS_PER_GROUP(s) * \
295 				       (g))
296 
297 /*
298  * Constants relative to the data blocks
299  */
300 #define EXT2_NDIR_BLOCKS		12
301 #define EXT2_IND_BLOCK			EXT2_NDIR_BLOCKS
302 #define EXT2_DIND_BLOCK			(EXT2_IND_BLOCK + 1)
303 #define EXT2_TIND_BLOCK			(EXT2_DIND_BLOCK + 1)
304 #define EXT2_N_BLOCKS			(EXT2_TIND_BLOCK + 1)
305 
306 /*
307  * Inode flags
308  */
309 #define EXT2_SECRM_FL			0x00000001 /* Secure deletion */
310 #define EXT2_UNRM_FL			0x00000002 /* Undelete */
311 #define EXT2_COMPR_FL			0x00000004 /* Compress file */
312 #define EXT2_SYNC_FL			0x00000008 /* Synchronous updates */
313 #define EXT2_IMMUTABLE_FL		0x00000010 /* Immutable file */
314 #define EXT2_APPEND_FL			0x00000020 /* writes to file may only append */
315 #define EXT2_NODUMP_FL			0x00000040 /* do not dump file */
316 #define EXT2_NOATIME_FL			0x00000080 /* do not update atime */
317 /* Reserved for compression usage... */
318 #define EXT2_DIRTY_FL			0x00000100
319 #define EXT2_COMPRBLK_FL		0x00000200 /* One or more compressed clusters */
320 #define EXT2_NOCOMPR_FL			0x00000400 /* Access raw compressed data */
321 	/* nb: was previously EXT2_ECOMPR_FL */
322 #define EXT4_ENCRYPT_FL			0x00000800 /* encrypted inode */
323 /* End compression flags --- maybe not all used */
324 #define EXT2_BTREE_FL			0x00001000 /* btree format dir */
325 #define EXT2_INDEX_FL			0x00001000 /* hash-indexed directory */
326 #define EXT2_IMAGIC_FL			0x00002000
327 #define EXT3_JOURNAL_DATA_FL		0x00004000 /* file data should be journaled */
328 #define EXT2_NOTAIL_FL			0x00008000 /* file tail should not be merged */
329 #define EXT2_DIRSYNC_FL 		0x00010000 /* Synchronous directory modifications */
330 #define EXT2_TOPDIR_FL			0x00020000 /* Top of directory hierarchies*/
331 #define EXT4_HUGE_FILE_FL               0x00040000 /* Set to each huge file */
332 #define EXT4_EXTENTS_FL 		0x00080000 /* Inode uses extents */
333 #define EXT4_VERITY_FL			0x00100000 /* Verity protected inode */
334 #define EXT4_EA_INODE_FL	        0x00200000 /* Inode used for large EA */
335 /* EXT4_EOFBLOCKS_FL 0x00400000 was here */
336 #define FS_NOCOW_FL			0x00800000 /* Do not cow file */
337 #define EXT4_SNAPFILE_FL		0x01000000  /* Inode is a snapshot */
338 #define EXT4_SNAPFILE_DELETED_FL	0x04000000  /* Snapshot is being deleted */
339 #define EXT4_SNAPFILE_SHRUNK_FL		0x08000000  /* Snapshot shrink has completed */
340 #define EXT4_INLINE_DATA_FL		0x10000000 /* Inode has inline data */
341 #define EXT4_PROJINHERIT_FL		0x20000000 /* Create with parents projid */
342 #define EXT2_RESERVED_FL		0x80000000 /* reserved for ext2 lib */
343 
344 #define EXT2_FL_USER_VISIBLE		0x204BDFFF /* User visible flags */
345 #define EXT2_FL_USER_MODIFIABLE		0x204B80FF /* User modifiable flags */
346 
347 /*
348  * ioctl commands
349  */
350 
351 /* Used for online resize */
352 struct ext2_new_group_input {
353 	__u32 group;		/* Group number for this data */
354 	__u32 block_bitmap;	/* Absolute block number of block bitmap */
355 	__u32 inode_bitmap;	/* Absolute block number of inode bitmap */
356 	__u32 inode_table;	/* Absolute block number of inode table start */
357 	__u32 blocks_count;	/* Total number of blocks in this group */
358 	__u16 reserved_blocks;	/* Number of reserved blocks in this group */
359 	__u16 unused;		/* Number of reserved GDT blocks in group */
360 };
361 
362 struct ext4_new_group_input {
363 	__u32 group;		/* Group number for this data */
364 	__u64 block_bitmap;	/* Absolute block number of block bitmap */
365 	__u64 inode_bitmap;	/* Absolute block number of inode bitmap */
366 	__u64 inode_table;	/* Absolute block number of inode table start */
367 	__u32 blocks_count;	/* Total number of blocks in this group */
368 	__u16 reserved_blocks;	/* Number of reserved blocks in this group */
369 	__u16 unused;
370 };
371 
372 #ifdef __GNU__			/* Needed for the Hurd */
373 #define _IOT_ext2_new_group_input _IOT (_IOTS(__u32), 5, _IOTS(__u16), 2, 0, 0)
374 #endif
375 
376 #define EXT2_IOC_GETFLAGS		_IOR('f', 1, long)
377 #define EXT2_IOC_SETFLAGS		_IOW('f', 2, long)
378 #define EXT2_IOC_GETVERSION		_IOR('v', 1, long)
379 #define EXT2_IOC_SETVERSION		_IOW('v', 2, long)
380 #define EXT2_IOC_GETVERSION_NEW		_IOR('f', 3, long)
381 #define EXT2_IOC_SETVERSION_NEW		_IOW('f', 4, long)
382 #define EXT2_IOC_GROUP_EXTEND		_IOW('f', 7, unsigned long)
383 #define EXT2_IOC_GROUP_ADD		_IOW('f', 8,struct ext2_new_group_input)
384 #define EXT4_IOC_GROUP_ADD		_IOW('f', 8,struct ext4_new_group_input)
385 #define EXT4_IOC_RESIZE_FS		_IOW('f', 16, __u64)
386 
387 /*
388  * Structure of an inode on the disk
389  */
390 struct ext2_inode {
391 /*00*/	__u16	i_mode;		/* File mode */
392 	__u16	i_uid;		/* Low 16 bits of Owner Uid */
393 	__u32	i_size;		/* Size in bytes */
394 	__u32	i_atime;	/* Access time */
395 	__u32	i_ctime;	/* Inode change time */
396 /*10*/	__u32	i_mtime;	/* Modification time */
397 	__u32	i_dtime;	/* Deletion Time */
398 	__u16	i_gid;		/* Low 16 bits of Group Id */
399 	__u16	i_links_count;	/* Links count */
400 	__u32	i_blocks;	/* Blocks count */
401 /*20*/	__u32	i_flags;	/* File flags */
402 	union {
403 		struct {
404 			__u32	l_i_version; /* was l_i_reserved1 */
405 		} linux1;
406 		struct {
407 			__u32  h_i_translator;
408 		} hurd1;
409 	} osd1;				/* OS dependent 1 */
410 /*28*/	__u32	i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
411 /*64*/	__u32	i_generation;	/* File version (for NFS) */
412 	__u32	i_file_acl;	/* File ACL */
413 	__u32	i_size_high;
414 /*70*/	__u32	i_faddr;	/* Fragment address */
415 	union {
416 		struct {
417 			__u16	l_i_blocks_hi;
418 			__u16	l_i_file_acl_high;
419 			__u16	l_i_uid_high;	/* these 2 fields    */
420 			__u16	l_i_gid_high;	/* were reserved2[0] */
421 			__u16	l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
422 			__u16	l_i_reserved;
423 		} linux2;
424 		struct {
425 			__u8	h_i_frag;	/* Fragment number */
426 			__u8	h_i_fsize;	/* Fragment size */
427 			__u16	h_i_mode_high;
428 			__u16	h_i_uid_high;
429 			__u16	h_i_gid_high;
430 			__u32	h_i_author;
431 		} hurd2;
432 	} osd2;				/* OS dependent 2 */
433 };
434 
435 /*
436  * Permanent part of an large inode on the disk
437  */
438 struct ext2_inode_large {
439 /*00*/	__u16	i_mode;		/* File mode */
440 	__u16	i_uid;		/* Low 16 bits of Owner Uid */
441 	__u32	i_size;		/* Size in bytes */
442 	__u32	i_atime;	/* Access time */
443 	__u32	i_ctime;	/* Inode Change time */
444 /*10*/	__u32	i_mtime;	/* Modification time */
445 	__u32	i_dtime;	/* Deletion Time */
446 	__u16	i_gid;		/* Low 16 bits of Group Id */
447 	__u16	i_links_count;	/* Links count */
448 	__u32	i_blocks;	/* Blocks count */
449 /*20*/	__u32	i_flags;	/* File flags */
450 	union {
451 		struct {
452 			__u32	l_i_version; /* was l_i_reserved1 */
453 		} linux1;
454 		struct {
455 			__u32  h_i_translator;
456 		} hurd1;
457 	} osd1;				/* OS dependent 1 */
458 /*28*/	__u32	i_block[EXT2_N_BLOCKS];/* Pointers to blocks */
459 /*64*/	__u32	i_generation;	/* File version (for NFS) */
460 	__u32	i_file_acl;	/* File ACL */
461 	__u32	i_size_high;
462 /*70*/	__u32	i_faddr;	/* Fragment address */
463 	union {
464 		struct {
465 			__u16	l_i_blocks_hi;
466 			__u16	l_i_file_acl_high;
467 			__u16	l_i_uid_high;	/* these 2 fields    */
468 			__u16	l_i_gid_high;	/* were reserved2[0] */
469 			__u16	l_i_checksum_lo; /* crc32c(uuid+inum+inode) */
470 			__u16	l_i_reserved;
471 		} linux2;
472 		struct {
473 			__u8	h_i_frag;	/* Fragment number */
474 			__u8	h_i_fsize;	/* Fragment size */
475 			__u16	h_i_mode_high;
476 			__u16	h_i_uid_high;
477 			__u16	h_i_gid_high;
478 			__u32	h_i_author;
479 		} hurd2;
480 	} osd2;				/* OS dependent 2 */
481 /*80*/	__u16	i_extra_isize;
482 	__u16	i_checksum_hi;	/* crc32c(uuid+inum+inode) */
483 	__u32	i_ctime_extra;	/* extra Change time (nsec << 2 | epoch) */
484 	__u32	i_mtime_extra;	/* extra Modification time (nsec << 2 | epoch) */
485 	__u32	i_atime_extra;	/* extra Access time (nsec << 2 | epoch) */
486 /*90*/	__u32	i_crtime;	/* File creation time */
487 	__u32	i_crtime_extra;	/* extra File creation time (nsec << 2 | epoch)*/
488 	__u32	i_version_hi;	/* high 32 bits for 64-bit version */
489 /*9c*/	__u32   i_projid;       /* Project ID */
490 };
491 
492 #define EXT4_INODE_CSUM_HI_EXTRA_END	\
493 	(offsetof(struct ext2_inode_large, i_checksum_hi) + sizeof(__u16) - \
494 	 EXT2_GOOD_OLD_INODE_SIZE)
495 
496 #define EXT4_EPOCH_BITS 2
497 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
498 
499 #define i_checksum_lo	osd2.linux2.l_i_checksum_lo
500 
501 #define inode_includes(size, field)			\
502        (size >= (sizeof(((struct ext2_inode_large *)0)->field) + \
503                  offsetof(struct ext2_inode_large, field)))
504 
505 #if defined(__KERNEL__) || defined(__linux__)
506 #define i_reserved1	osd1.linux1.l_i_reserved1
507 #define i_frag		osd2.linux2.l_i_frag
508 #define i_fsize		osd2.linux2.l_i_fsize
509 #define i_uid_low	i_uid
510 #define i_gid_low	i_gid
511 #define i_uid_high	osd2.linux2.l_i_uid_high
512 #define i_gid_high	osd2.linux2.l_i_gid_high
513 #else
514 #if defined(__GNU__)
515 
516 #define i_translator	osd1.hurd1.h_i_translator
517 #define i_frag		osd2.hurd2.h_i_frag;
518 #define i_fsize		osd2.hurd2.h_i_fsize;
519 #define i_uid_high	osd2.hurd2.h_i_uid_high
520 #define i_gid_high	osd2.hurd2.h_i_gid_high
521 #define i_author	osd2.hurd2.h_i_author
522 
523 #endif  /* __GNU__ */
524 #endif	/* defined(__KERNEL__) || defined(__linux__) */
525 
526 #define inode_uid(inode)	((inode).i_uid | (inode).osd2.linux2.l_i_uid_high << 16)
527 #define inode_gid(inode)	((inode).i_gid | (inode).osd2.linux2.l_i_gid_high << 16)
528 #define inode_projid(inode)	((inode).i_projid)
529 #define ext2fs_set_i_uid_high(inode,x) ((inode).osd2.linux2.l_i_uid_high = (x))
530 #define ext2fs_set_i_gid_high(inode,x) ((inode).osd2.linux2.l_i_gid_high = (x))
531 
532 static inline
EXT2_INODE(struct ext2_inode_large * large_inode)533 struct ext2_inode *EXT2_INODE(struct ext2_inode_large *large_inode)
534 {
535 	return (struct ext2_inode *) large_inode;
536 }
537 
538 /*
539  * File system states
540  */
541 #define EXT2_VALID_FS			0x0001	/* Unmounted cleanly */
542 #define EXT2_ERROR_FS			0x0002	/* Errors detected */
543 #define EXT3_ORPHAN_FS			0x0004	/* Orphans being recovered */
544 
545 /*
546  * Misc. filesystem flags
547  */
548 #define EXT2_FLAGS_SIGNED_HASH		0x0001  /* Signed dirhash in use */
549 #define EXT2_FLAGS_UNSIGNED_HASH	0x0002  /* Unsigned dirhash in use */
550 #define EXT2_FLAGS_TEST_FILESYS		0x0004	/* OK for use on development code */
551 #define EXT2_FLAGS_IS_SNAPSHOT		0x0010	/* This is a snapshot image */
552 #define EXT2_FLAGS_FIX_SNAPSHOT		0x0020	/* Snapshot inodes corrupted */
553 #define EXT2_FLAGS_FIX_EXCLUDE		0x0040	/* Exclude bitmaps corrupted */
554 
555 /*
556  * Mount flags
557  */
558 #define EXT2_MOUNT_CHECK		0x0001	/* Do mount-time checks */
559 #define EXT2_MOUNT_GRPID		0x0004	/* Create files with directory's group */
560 #define EXT2_MOUNT_DEBUG		0x0008	/* Some debugging messages */
561 #define EXT2_MOUNT_ERRORS_CONT		0x0010	/* Continue on errors */
562 #define EXT2_MOUNT_ERRORS_RO		0x0020	/* Remount fs ro on errors */
563 #define EXT2_MOUNT_ERRORS_PANIC		0x0040	/* Panic on errors */
564 #define EXT2_MOUNT_MINIX_DF		0x0080	/* Mimics the Minix statfs */
565 #define EXT2_MOUNT_NO_UID32		0x0200  /* Disable 32-bit UIDs */
566 
567 #define clear_opt(o, opt)		o &= ~EXT2_MOUNT_##opt
568 #define set_opt(o, opt)			o |= EXT2_MOUNT_##opt
569 #define test_opt(sb, opt)		(EXT2_SB(sb)->s_mount_opt & \
570 					 EXT2_MOUNT_##opt)
571 /*
572  * Maximal mount counts between two filesystem checks
573  */
574 #define EXT2_DFL_MAX_MNT_COUNT		20	/* Allow 20 mounts */
575 #define EXT2_DFL_CHECKINTERVAL		0	/* Don't use interval check */
576 
577 /*
578  * Behaviour when detecting errors
579  */
580 #define EXT2_ERRORS_CONTINUE		1	/* Continue execution */
581 #define EXT2_ERRORS_RO			2	/* Remount fs read-only */
582 #define EXT2_ERRORS_PANIC		3	/* Panic */
583 #define EXT2_ERRORS_DEFAULT		EXT2_ERRORS_CONTINUE
584 
585 #if (__GNUC__ >= 4)
586 #define ext4_offsetof(TYPE,MEMBER) __builtin_offsetof(TYPE,MEMBER)
587 #else
588 #define ext4_offsetof(TYPE, MEMBER) ((size_t) &((TYPE *)0)->MEMBER)
589 #endif
590 
591 /* Metadata checksum algorithms */
592 #define EXT2_CRC32C_CHKSUM		1
593 
594 /* Encryption algorithms, key size and key reference len */
595 #define EXT4_ENCRYPTION_MODE_INVALID		0
596 #define EXT4_ENCRYPTION_MODE_AES_256_XTS	1
597 #define EXT4_ENCRYPTION_MODE_AES_256_GCM	2
598 #define EXT4_ENCRYPTION_MODE_AES_256_CBC	3
599 #define EXT4_ENCRYPTION_MODE_AES_256_CTS	4
600 
601 #define EXT4_AES_256_XTS_KEY_SIZE		64
602 #define EXT4_AES_256_GCM_KEY_SIZE		32
603 #define EXT4_AES_256_CBC_KEY_SIZE		32
604 #define EXT4_AES_256_CTS_KEY_SIZE		32
605 #define EXT4_MAX_KEY_SIZE			64
606 
607 #define EXT4_KEY_DESCRIPTOR_SIZE		8
608 #define EXT4_CRYPTO_BLOCK_SIZE			16
609 
610 /* Password derivation constants */
611 #define EXT4_MAX_PASSPHRASE_SIZE		1024
612 #define EXT4_MAX_SALT_SIZE			256
613 #define EXT4_PBKDF2_ITERATIONS			0xFFFF
614 
615 #define EXT2_LABEL_LEN				16
616 
617 /*
618  * Policy provided via an ioctl on the topmost directory. This
619  * structure is also in the kernel.
620  */
621 struct ext4_encryption_policy {
622   char version;
623   char contents_encryption_mode;
624   char filenames_encryption_mode;
625   char flags;
626   char master_key_descriptor[EXT4_KEY_DESCRIPTOR_SIZE];
627 } __attribute__((__packed__));
628 
629 struct ext4_encryption_key {
630         __u32 mode;
631         char raw[EXT4_MAX_KEY_SIZE];
632         __u32 size;
633 } __attribute__((__packed__));
634 
635 /*
636  * Structure of the super block
637  */
638 struct ext2_super_block {
639 /*000*/	__u32	s_inodes_count;		/* Inodes count */
640 	__u32	s_blocks_count;		/* Blocks count */
641 	__u32	s_r_blocks_count;	/* Reserved blocks count */
642 	__u32	s_free_blocks_count;	/* Free blocks count */
643 /*010*/	__u32	s_free_inodes_count;	/* Free inodes count */
644 	__u32	s_first_data_block;	/* First Data Block */
645 	__u32	s_log_block_size;	/* Block size */
646 	__u32	s_log_cluster_size;	/* Allocation cluster size */
647 /*020*/	__u32	s_blocks_per_group;	/* # Blocks per group */
648 	__u32	s_clusters_per_group;	/* # Fragments per group */
649 	__u32	s_inodes_per_group;	/* # Inodes per group */
650 	__u32	s_mtime;		/* Mount time */
651 /*030*/	__u32	s_wtime;		/* Write time */
652 	__u16	s_mnt_count;		/* Mount count */
653 	__s16	s_max_mnt_count;	/* Maximal mount count */
654 	__u16	s_magic;		/* Magic signature */
655 	__u16	s_state;		/* File system state */
656 	__u16	s_errors;		/* Behaviour when detecting errors */
657 	__u16	s_minor_rev_level;	/* minor revision level */
658 /*040*/	__u32	s_lastcheck;		/* time of last check */
659 	__u32	s_checkinterval;	/* max. time between checks */
660 	__u32	s_creator_os;		/* OS */
661 	__u32	s_rev_level;		/* Revision level */
662 /*050*/	__u16	s_def_resuid;		/* Default uid for reserved blocks */
663 	__u16	s_def_resgid;		/* Default gid for reserved blocks */
664 	/*
665 	 * These fields are for EXT2_DYNAMIC_REV superblocks only.
666 	 *
667 	 * Note: the difference between the compatible feature set and
668 	 * the incompatible feature set is that if there is a bit set
669 	 * in the incompatible feature set that the kernel doesn't
670 	 * know about, it should refuse to mount the filesystem.
671 	 *
672 	 * e2fsck's requirements are more strict; if it doesn't know
673 	 * about a feature in either the compatible or incompatible
674 	 * feature set, it must abort and not try to meddle with
675 	 * things it doesn't understand...
676 	 */
677 	__u32	s_first_ino;		/* First non-reserved inode */
678 	__u16   s_inode_size;		/* size of inode structure */
679 	__u16	s_block_group_nr;	/* block group # of this superblock */
680 	__u32	s_feature_compat;	/* compatible feature set */
681 /*060*/	__u32	s_feature_incompat;	/* incompatible feature set */
682 	__u32	s_feature_ro_compat;	/* readonly-compatible feature set */
683 /*068*/	__u8	s_uuid[16];		/* 128-bit uuid for volume */
684 /*078*/	char	s_volume_name[EXT2_LABEL_LEN];	/* volume name */
685 /*088*/	char	s_last_mounted[64];	/* directory where last mounted */
686 /*0c8*/	__u32	s_algorithm_usage_bitmap; /* For compression */
687 	/*
688 	 * Performance hints.  Directory preallocation should only
689 	 * happen if the EXT2_FEATURE_COMPAT_DIR_PREALLOC flag is on.
690 	 */
691 	__u8	s_prealloc_blocks;	/* Nr of blocks to try to preallocate*/
692 	__u8	s_prealloc_dir_blocks;	/* Nr to preallocate for dirs */
693 	__u16	s_reserved_gdt_blocks;	/* Per group table for online growth */
694 	/*
695 	 * Journaling support valid if EXT2_FEATURE_COMPAT_HAS_JOURNAL set.
696 	 */
697 /*0d0*/	__u8	s_journal_uuid[16];	/* uuid of journal superblock */
698 /*0e0*/	__u32	s_journal_inum;		/* inode number of journal file */
699 	__u32	s_journal_dev;		/* device number of journal file */
700 	__u32	s_last_orphan;		/* start of list of inodes to delete */
701 /*0ec*/	__u32	s_hash_seed[4];		/* HTREE hash seed */
702 /*0fc*/	__u8	s_def_hash_version;	/* Default hash version to use */
703 	__u8	s_jnl_backup_type;	/* Default type of journal backup */
704 	__u16	s_desc_size;		/* Group desc. size: INCOMPAT_64BIT */
705 /*100*/	__u32	s_default_mount_opts;	/* default EXT2_MOUNT_* flags used */
706 	__u32	s_first_meta_bg;	/* First metablock group */
707 	__u32	s_mkfs_time;		/* When the filesystem was created */
708 /*10c*/	__u32	s_jnl_blocks[17];	/* Backup of the journal inode */
709 /*150*/	__u32	s_blocks_count_hi;	/* Blocks count high 32bits */
710 	__u32	s_r_blocks_count_hi;	/* Reserved blocks count high 32 bits*/
711 	__u32	s_free_blocks_hi;	/* Free blocks count */
712 	__u16	s_min_extra_isize;	/* All inodes have at least # bytes */
713 	__u16	s_want_extra_isize;	/* New inodes should reserve # bytes */
714 /*160*/	__u32	s_flags;		/* Miscellaneous flags */
715 	__u16	s_raid_stride;		/* RAID stride in blocks */
716 	__u16	s_mmp_update_interval;  /* # seconds to wait in MMP checking */
717 	__u64	s_mmp_block;		/* Block for multi-mount protection */
718 /*170*/	__u32	s_raid_stripe_width;	/* blocks on all data disks (N*stride)*/
719 	__u8	s_log_groups_per_flex;	/* FLEX_BG group size */
720 	__u8	s_checksum_type;	/* metadata checksum algorithm */
721 	__u8	s_encryption_level;	/* versioning level for encryption */
722 	__u8	s_reserved_pad;		/* Padding to next 32bits */
723 	__u64	s_kbytes_written;	/* nr of lifetime kilobytes written */
724 /*180*/	__u32	s_snapshot_inum;	/* Inode number of active snapshot */
725 	__u32	s_snapshot_id;		/* sequential ID of active snapshot */
726 	__u64	s_snapshot_r_blocks_count; /* active snapshot reserved blocks */
727 /*190*/	__u32	s_snapshot_list;	/* inode number of disk snapshot list */
728 #define EXT4_S_ERR_START ext4_offsetof(struct ext2_super_block, s_error_count)
729 	__u32	s_error_count;		/* number of fs errors */
730 	__u32	s_first_error_time;	/* first time an error happened */
731 	__u32	s_first_error_ino;	/* inode involved in first error */
732 /*1a0*/	__u64	s_first_error_block;	/* block involved in first error */
733 	__u8	s_first_error_func[32];	/* function where the error happened */
734 /*1c8*/	__u32	s_first_error_line;	/* line number where error happened */
735 	__u32	s_last_error_time;	/* most recent time of an error */
736 /*1d0*/	__u32	s_last_error_ino;	/* inode involved in last error */
737 	__u32	s_last_error_line;	/* line number where error happened */
738 	__u64	s_last_error_block;	/* block involved of last error */
739 /*1e0*/	__u8	s_last_error_func[32];	/* function where the error happened */
740 #define EXT4_S_ERR_END ext4_offsetof(struct ext2_super_block, s_mount_opts)
741 /*200*/	__u8	s_mount_opts[64];
742 /*240*/	__u32	s_usr_quota_inum;	/* inode number of user quota file */
743 	__u32	s_grp_quota_inum;	/* inode number of group quota file */
744 	__u32	s_overhead_blocks;	/* overhead blocks/clusters in fs */
745 /*24c*/	__u32	s_backup_bgs[2];	/* If sparse_super2 enabled */
746 /*254*/	__u8	s_encrypt_algos[4];	/* Encryption algorithms in use  */
747 /*258*/	__u8	s_encrypt_pw_salt[16];	/* Salt used for string2key algorithm */
748 /*268*/	__le32	s_lpf_ino;		/* Location of the lost+found inode */
749 	__le32  s_prj_quota_inum;	/* inode for tracking project quota */
750 /*270*/	__le32	s_checksum_seed;	/* crc32c(orig_uuid) if csum_seed set */
751 	__le32	s_reserved[98];		/* Padding to the end of the block */
752 /*3fc*/	__u32	s_checksum;		/* crc32c(superblock) */
753 };
754 
755 #define EXT4_S_ERR_LEN (EXT4_S_ERR_END - EXT4_S_ERR_START)
756 
757 /*
758  * Codes for operating systems
759  */
760 #define EXT2_OS_LINUX		0
761 #define EXT2_OS_HURD		1
762 #define EXT2_OBSO_OS_MASIX	2
763 #define EXT2_OS_FREEBSD		3
764 #define EXT2_OS_LITES		4
765 
766 /*
767  * Revision levels
768  */
769 #define EXT2_GOOD_OLD_REV	0	/* The good old (original) format */
770 #define EXT2_DYNAMIC_REV	1	/* V2 format w/ dynamic inode sizes */
771 
772 #define EXT2_CURRENT_REV	EXT2_GOOD_OLD_REV
773 #define EXT2_MAX_SUPP_REV	EXT2_DYNAMIC_REV
774 
775 #define EXT2_GOOD_OLD_INODE_SIZE 128
776 
777 /*
778  * Journal inode backup types
779  */
780 #define EXT3_JNL_BACKUP_BLOCKS	1
781 
782 /*
783  * Feature set definitions
784  */
785 
786 #define EXT2_HAS_COMPAT_FEATURE(sb,mask)			\
787 	( EXT2_SB(sb)->s_feature_compat & (mask) )
788 #define EXT2_HAS_RO_COMPAT_FEATURE(sb,mask)			\
789 	( EXT2_SB(sb)->s_feature_ro_compat & (mask) )
790 #define EXT2_HAS_INCOMPAT_FEATURE(sb,mask)			\
791 	( EXT2_SB(sb)->s_feature_incompat & (mask) )
792 
793 #define EXT2_FEATURE_COMPAT_DIR_PREALLOC	0x0001
794 #define EXT2_FEATURE_COMPAT_IMAGIC_INODES	0x0002
795 #define EXT3_FEATURE_COMPAT_HAS_JOURNAL		0x0004
796 #define EXT2_FEATURE_COMPAT_EXT_ATTR		0x0008
797 #define EXT2_FEATURE_COMPAT_RESIZE_INODE	0x0010
798 #define EXT2_FEATURE_COMPAT_DIR_INDEX		0x0020
799 #define EXT2_FEATURE_COMPAT_LAZY_BG		0x0040
800 /* #define EXT2_FEATURE_COMPAT_EXCLUDE_INODE	0x0080 not used, legacy */
801 #define EXT2_FEATURE_COMPAT_EXCLUDE_BITMAP	0x0100
802 #define EXT4_FEATURE_COMPAT_SPARSE_SUPER2	0x0200
803 
804 
805 #define EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER	0x0001
806 #define EXT2_FEATURE_RO_COMPAT_LARGE_FILE	0x0002
807 /* #define EXT2_FEATURE_RO_COMPAT_BTREE_DIR	0x0004 not used */
808 #define EXT4_FEATURE_RO_COMPAT_HUGE_FILE	0x0008
809 #define EXT4_FEATURE_RO_COMPAT_GDT_CSUM		0x0010
810 #define EXT4_FEATURE_RO_COMPAT_DIR_NLINK	0x0020
811 #define EXT4_FEATURE_RO_COMPAT_EXTRA_ISIZE	0x0040
812 #define EXT4_FEATURE_RO_COMPAT_HAS_SNAPSHOT	0x0080
813 #define EXT4_FEATURE_RO_COMPAT_QUOTA		0x0100
814 #define EXT4_FEATURE_RO_COMPAT_BIGALLOC		0x0200
815 /*
816  * METADATA_CSUM implies GDT_CSUM.  When METADATA_CSUM is set, group
817  * descriptor checksums use the same algorithm as all other data
818  * structures' checksums.
819  */
820 #define EXT4_FEATURE_RO_COMPAT_METADATA_CSUM	0x0400
821 #define EXT4_FEATURE_RO_COMPAT_REPLICA		0x0800
822 #define EXT4_FEATURE_RO_COMPAT_READONLY		0x1000
823 #define EXT4_FEATURE_RO_COMPAT_PROJECT		0x2000 /* Project quota */
824 #define EXT4_FEATURE_RO_COMPAT_SHARED_BLOCKS	0x4000
825 #define EXT4_FEATURE_RO_COMPAT_VERITY		0x8000
826 
827 #define EXT2_FEATURE_INCOMPAT_COMPRESSION	0x0001
828 #define EXT2_FEATURE_INCOMPAT_FILETYPE		0x0002
829 #define EXT3_FEATURE_INCOMPAT_RECOVER		0x0004 /* Needs recovery */
830 #define EXT3_FEATURE_INCOMPAT_JOURNAL_DEV	0x0008 /* Journal device */
831 #define EXT2_FEATURE_INCOMPAT_META_BG		0x0010
832 #define EXT3_FEATURE_INCOMPAT_EXTENTS		0x0040
833 #define EXT4_FEATURE_INCOMPAT_64BIT		0x0080
834 #define EXT4_FEATURE_INCOMPAT_MMP		0x0100
835 #define EXT4_FEATURE_INCOMPAT_FLEX_BG		0x0200
836 #define EXT4_FEATURE_INCOMPAT_EA_INODE		0x0400
837 #define EXT4_FEATURE_INCOMPAT_DIRDATA		0x1000
838 #define EXT4_FEATURE_INCOMPAT_CSUM_SEED		0x2000
839 #define EXT4_FEATURE_INCOMPAT_LARGEDIR		0x4000 /* >2GB or 3-lvl htree */
840 #define EXT4_FEATURE_INCOMPAT_INLINE_DATA	0x8000 /* data in inode */
841 #define EXT4_FEATURE_INCOMPAT_ENCRYPT		0x10000
842 
843 #define EXT4_FEATURE_COMPAT_FUNCS(name, ver, flagname) \
844 static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
845 { \
846 	return ((EXT2_SB(sb)->s_feature_compat & \
847 		 EXT##ver##_FEATURE_COMPAT_##flagname) != 0); \
848 } \
849 static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
850 { \
851 	EXT2_SB(sb)->s_feature_compat |= \
852 		EXT##ver##_FEATURE_COMPAT_##flagname; \
853 } \
854 static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
855 { \
856 	EXT2_SB(sb)->s_feature_compat &= \
857 		~EXT##ver##_FEATURE_COMPAT_##flagname; \
858 }
859 
860 #define EXT4_FEATURE_RO_COMPAT_FUNCS(name, ver, flagname) \
861 static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
862 { \
863 	return ((EXT2_SB(sb)->s_feature_ro_compat & \
864 		 EXT##ver##_FEATURE_RO_COMPAT_##flagname) != 0); \
865 } \
866 static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
867 { \
868 	EXT2_SB(sb)->s_feature_ro_compat |= \
869 		EXT##ver##_FEATURE_RO_COMPAT_##flagname; \
870 } \
871 static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
872 { \
873 	EXT2_SB(sb)->s_feature_ro_compat &= \
874 		~EXT##ver##_FEATURE_RO_COMPAT_##flagname; \
875 }
876 
877 #define EXT4_FEATURE_INCOMPAT_FUNCS(name, ver, flagname) \
878 static inline int ext2fs_has_feature_##name(struct ext2_super_block *sb) \
879 { \
880 	return ((EXT2_SB(sb)->s_feature_incompat & \
881 		 EXT##ver##_FEATURE_INCOMPAT_##flagname) != 0); \
882 } \
883 static inline void ext2fs_set_feature_##name(struct ext2_super_block *sb) \
884 { \
885 	EXT2_SB(sb)->s_feature_incompat |= \
886 		EXT##ver##_FEATURE_INCOMPAT_##flagname; \
887 } \
888 static inline void ext2fs_clear_feature_##name(struct ext2_super_block *sb) \
889 { \
890 	EXT2_SB(sb)->s_feature_incompat &= \
891 		~EXT##ver##_FEATURE_INCOMPAT_##flagname; \
892 }
893 
894 EXT4_FEATURE_COMPAT_FUNCS(dir_prealloc,		2, DIR_PREALLOC)
895 EXT4_FEATURE_COMPAT_FUNCS(imagic_inodes,	2, IMAGIC_INODES)
896 EXT4_FEATURE_COMPAT_FUNCS(journal,		3, HAS_JOURNAL)
897 EXT4_FEATURE_COMPAT_FUNCS(xattr,		2, EXT_ATTR)
898 EXT4_FEATURE_COMPAT_FUNCS(resize_inode,		2, RESIZE_INODE)
899 EXT4_FEATURE_COMPAT_FUNCS(dir_index,		2, DIR_INDEX)
900 EXT4_FEATURE_COMPAT_FUNCS(lazy_bg,		2, LAZY_BG)
901 EXT4_FEATURE_COMPAT_FUNCS(exclude_bitmap,	2, EXCLUDE_BITMAP)
902 EXT4_FEATURE_COMPAT_FUNCS(sparse_super2,	4, SPARSE_SUPER2)
903 
904 EXT4_FEATURE_RO_COMPAT_FUNCS(sparse_super,	2, SPARSE_SUPER)
905 EXT4_FEATURE_RO_COMPAT_FUNCS(large_file,	2, LARGE_FILE)
906 EXT4_FEATURE_RO_COMPAT_FUNCS(huge_file,		4, HUGE_FILE)
907 EXT4_FEATURE_RO_COMPAT_FUNCS(gdt_csum,		4, GDT_CSUM)
908 EXT4_FEATURE_RO_COMPAT_FUNCS(dir_nlink,		4, DIR_NLINK)
909 EXT4_FEATURE_RO_COMPAT_FUNCS(extra_isize,	4, EXTRA_ISIZE)
910 EXT4_FEATURE_RO_COMPAT_FUNCS(has_snapshot,	4, HAS_SNAPSHOT)
911 EXT4_FEATURE_RO_COMPAT_FUNCS(quota,		4, QUOTA)
912 EXT4_FEATURE_RO_COMPAT_FUNCS(bigalloc,		4, BIGALLOC)
913 EXT4_FEATURE_RO_COMPAT_FUNCS(metadata_csum,	4, METADATA_CSUM)
914 EXT4_FEATURE_RO_COMPAT_FUNCS(replica,		4, REPLICA)
915 EXT4_FEATURE_RO_COMPAT_FUNCS(readonly,		4, READONLY)
916 EXT4_FEATURE_RO_COMPAT_FUNCS(project,		4, PROJECT)
917 EXT4_FEATURE_RO_COMPAT_FUNCS(shared_blocks,	4, SHARED_BLOCKS)
918 EXT4_FEATURE_RO_COMPAT_FUNCS(verity,		4, VERITY)
919 
920 EXT4_FEATURE_INCOMPAT_FUNCS(compression,	2, COMPRESSION)
921 EXT4_FEATURE_INCOMPAT_FUNCS(filetype,		2, FILETYPE)
922 EXT4_FEATURE_INCOMPAT_FUNCS(journal_needs_recovery,	3, RECOVER)
923 EXT4_FEATURE_INCOMPAT_FUNCS(journal_dev,	3, JOURNAL_DEV)
924 EXT4_FEATURE_INCOMPAT_FUNCS(meta_bg,		2, META_BG)
925 EXT4_FEATURE_INCOMPAT_FUNCS(extents,		3, EXTENTS)
926 EXT4_FEATURE_INCOMPAT_FUNCS(64bit,		4, 64BIT)
927 EXT4_FEATURE_INCOMPAT_FUNCS(mmp,		4, MMP)
928 EXT4_FEATURE_INCOMPAT_FUNCS(flex_bg,		4, FLEX_BG)
929 EXT4_FEATURE_INCOMPAT_FUNCS(ea_inode,		4, EA_INODE)
930 EXT4_FEATURE_INCOMPAT_FUNCS(dirdata,		4, DIRDATA)
931 EXT4_FEATURE_INCOMPAT_FUNCS(csum_seed,		4, CSUM_SEED)
932 EXT4_FEATURE_INCOMPAT_FUNCS(largedir,		4, LARGEDIR)
933 EXT4_FEATURE_INCOMPAT_FUNCS(inline_data,	4, INLINE_DATA)
934 EXT4_FEATURE_INCOMPAT_FUNCS(encrypt,		4, ENCRYPT)
935 
936 #define EXT2_FEATURE_COMPAT_SUPP	0
937 #define EXT2_FEATURE_INCOMPAT_SUPP    (EXT2_FEATURE_INCOMPAT_FILETYPE| \
938 				       EXT4_FEATURE_INCOMPAT_MMP| \
939 				       EXT4_FEATURE_INCOMPAT_LARGEDIR| \
940 				       EXT4_FEATURE_INCOMPAT_EA_INODE)
941 #define EXT2_FEATURE_RO_COMPAT_SUPP	(EXT2_FEATURE_RO_COMPAT_SPARSE_SUPER| \
942 					 EXT2_FEATURE_RO_COMPAT_LARGE_FILE| \
943 					 EXT4_FEATURE_RO_COMPAT_DIR_NLINK| \
944 					 EXT2_FEATURE_RO_COMPAT_BTREE_DIR| \
945 					 EXT4_FEATURE_RO_COMPAT_VERITY)
946 
947 /*
948  * Default values for user and/or group using reserved blocks
949  */
950 #define EXT2_DEF_RESUID		0
951 #define EXT2_DEF_RESGID		0
952 
953 /*
954  * Default mount options
955  */
956 #define EXT2_DEFM_DEBUG		0x0001
957 #define EXT2_DEFM_BSDGROUPS	0x0002
958 #define EXT2_DEFM_XATTR_USER	0x0004
959 #define EXT2_DEFM_ACL		0x0008
960 #define EXT2_DEFM_UID16		0x0010
961 #define EXT3_DEFM_JMODE		0x0060
962 #define EXT3_DEFM_JMODE_DATA	0x0020
963 #define EXT3_DEFM_JMODE_ORDERED	0x0040
964 #define EXT3_DEFM_JMODE_WBACK	0x0060
965 #define EXT4_DEFM_NOBARRIER	0x0100
966 #define EXT4_DEFM_BLOCK_VALIDITY 0x0200
967 #define EXT4_DEFM_DISCARD	0x0400
968 #define EXT4_DEFM_NODELALLOC	0x0800
969 
970 /*
971  * Structure of a directory entry
972  */
973 #define EXT2_NAME_LEN 255
974 
975 struct ext2_dir_entry {
976 	__u32	inode;			/* Inode number */
977 	__u16	rec_len;		/* Directory entry length */
978 	__u16	name_len;		/* Name length */
979 	char	name[EXT2_NAME_LEN];	/* File name */
980 };
981 
982 /*
983  * The new version of the directory entry.  Since EXT2 structures are
984  * stored in intel byte order, and the name_len field could never be
985  * bigger than 255 chars, it's safe to reclaim the extra byte for the
986  * file_type field.
987  *
988  * This structure is deprecated due to endian issues. Please use struct
989  * ext2_dir_entry and accessor functions
990  *   ext2fs_dirent_name_len
991  *   ext2fs_dirent_set_name_len
992  *   ext2fs_dirent_file_type
993  *   ext2fs_dirent_set_file_type
994  * to get and set name_len and file_type fields.
995  */
996 struct ext2_dir_entry_2 {
997 	__u32	inode;			/* Inode number */
998 	__u16	rec_len;		/* Directory entry length */
999 	__u8	name_len;		/* Name length */
1000 	__u8	file_type;
1001 	char	name[EXT2_NAME_LEN];	/* File name */
1002 };
1003 
1004 /*
1005  * This is a bogus directory entry at the end of each leaf block that
1006  * records checksums.
1007  */
1008 struct ext2_dir_entry_tail {
1009 	__u32	det_reserved_zero1;	/* Pretend to be unused */
1010 	__u16	det_rec_len;		/* 12 */
1011 	__u16	det_reserved_name_len;	/* 0xDE00, fake namelen/filetype */
1012 	__u32	det_checksum;		/* crc32c(uuid+inode+dirent) */
1013 };
1014 
1015 /*
1016  * Ext2 directory file types.  Only the low 3 bits are used.  The
1017  * other bits are reserved for now.
1018  */
1019 #define EXT2_FT_UNKNOWN		0
1020 #define EXT2_FT_REG_FILE	1
1021 #define EXT2_FT_DIR		2
1022 #define EXT2_FT_CHRDEV		3
1023 #define EXT2_FT_BLKDEV		4
1024 #define EXT2_FT_FIFO		5
1025 #define EXT2_FT_SOCK		6
1026 #define EXT2_FT_SYMLINK		7
1027 
1028 #define EXT2_FT_MAX		8
1029 
1030 /*
1031  * Annoyingly, e2fsprogs always swab16s ext2_dir_entry.name_len, so we
1032  * have to build ext2_dir_entry_tail with that assumption too.  This
1033  * constant helps to build the dir_entry_tail to look like it has an
1034  * "invalid" file type.
1035  */
1036 #define EXT2_DIR_NAME_LEN_CSUM	0xDE00
1037 
1038 /*
1039  * EXT2_DIR_PAD defines the directory entries boundaries
1040  *
1041  * NOTE: It must be a multiple of 4
1042  */
1043 #define EXT2_DIR_ENTRY_HEADER_LEN	8
1044 #define EXT2_DIR_PAD			4
1045 #define EXT2_DIR_ROUND			(EXT2_DIR_PAD - 1)
1046 #define EXT2_DIR_REC_LEN(name_len)	(((name_len) + \
1047 					  EXT2_DIR_ENTRY_HEADER_LEN + \
1048 					  EXT2_DIR_ROUND) & \
1049 					 ~EXT2_DIR_ROUND)
1050 
1051 /*
1052  * Constants for ext4's extended time encoding
1053  */
1054 #define EXT4_EPOCH_BITS 2
1055 #define EXT4_EPOCH_MASK ((1 << EXT4_EPOCH_BITS) - 1)
1056 #define EXT4_NSEC_MASK  (~0UL << EXT4_EPOCH_BITS)
1057 
1058 /*
1059  * This structure is used for multiple mount protection. It is written
1060  * into the block number saved in the s_mmp_block field in the superblock.
1061  * Programs that check MMP should assume that if SEQ_FSCK (or any unknown
1062  * code above SEQ_MAX) is present then it is NOT safe to use the filesystem,
1063  * regardless of how old the timestamp is.
1064  *
1065  * The timestamp in the MMP structure will be updated by e2fsck at some
1066  * arbitrary intervals (start of passes, after every few groups of inodes
1067  * in pass1 and pass1b).  There is no guarantee that e2fsck is updating
1068  * the MMP block in a timely manner, and the updates it does are purely
1069  * for the convenience of the sysadmin and not for automatic validation.
1070  *
1071  * Note: Only the mmp_seq value is used to determine whether the MMP block
1072  *	is being updated.  The mmp_time, mmp_nodename, and mmp_bdevname
1073  *	fields are only for informational purposes for the administrator,
1074  *	due to clock skew between nodes and hostname HA service takeover.
1075  */
1076 #define EXT4_MMP_MAGIC     0x004D4D50U /* ASCII for MMP */
1077 #define EXT4_MMP_SEQ_CLEAN 0xFF4D4D50U /* mmp_seq value for clean unmount */
1078 #define EXT4_MMP_SEQ_FSCK  0xE24D4D50U /* mmp_seq value when being fscked */
1079 #define EXT4_MMP_SEQ_MAX   0xE24D4D4FU /* maximum valid mmp_seq value */
1080 
1081 /* Not endian-annotated; it's swapped at read/write time */
1082 struct mmp_struct {
1083 	__u32	mmp_magic;		/* Magic number for MMP */
1084 	__u32	mmp_seq;		/* Sequence no. updated periodically */
1085 	__u64	mmp_time;		/* Time last updated */
1086 	char	mmp_nodename[64];	/* Node which last updated MMP block */
1087 	char	mmp_bdevname[32];	/* Bdev which last updated MMP block */
1088 	__u16	mmp_check_interval;	/* Changed mmp_check_interval */
1089 	__u16	mmp_pad1;
1090 	__u32	mmp_pad2[226];
1091 	__u32	mmp_checksum;		/* crc32c(uuid+mmp_block) */
1092 };
1093 
1094 /*
1095  * Default interval for MMP update in seconds.
1096  */
1097 #define EXT4_MMP_UPDATE_INTERVAL	5
1098 
1099 /*
1100  * Maximum interval for MMP update in seconds.
1101  */
1102 #define EXT4_MMP_MAX_UPDATE_INTERVAL	300
1103 
1104 /*
1105  * Minimum interval for MMP checking in seconds.
1106  */
1107 #define EXT4_MMP_MIN_CHECK_INTERVAL     5
1108 
1109 /*
1110  * Minimum size of inline data.
1111  */
1112 #define EXT4_MIN_INLINE_DATA_SIZE	((sizeof(__u32) * EXT2_N_BLOCKS))
1113 
1114 /*
1115  * Size of a parent inode in inline data directory.
1116  */
1117 #define EXT4_INLINE_DATA_DOTDOT_SIZE	(4)
1118 
1119 #endif	/* _LINUX_EXT2_FS_H */
1120